From 0c52e46db202ebccd2e258c9b746bf68ac771844 Mon Sep 17 00:00:00 2001 From: Takio Yamaoka Date: Mon, 27 Apr 2026 13:45:12 +0900 Subject: [PATCH 1/4] fix miss link of openapi of onvif-camera Signed-off-by: Takio Yamaoka --- .../device/services/device-onvif-camera/swagger.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs_src/microservices/device/services/device-onvif-camera/swagger.md b/docs_src/microservices/device/services/device-onvif-camera/swagger.md index eb0a3d269..2f85a3301 100644 --- a/docs_src/microservices/device/services/device-onvif-camera/swagger.md +++ b/docs_src/microservices/device/services/device-onvif-camera/swagger.md @@ -1,4 +1,5 @@ # Device ONVIF Swagger API Documentation + Use this RESTful API documentation to learn more about the capabilities of the device service. - + From 3b629f2435bcd42f5218245b058d65f4506014da Mon Sep 17 00:00:00 2001 From: Takio Yamaoka Date: Mon, 27 Apr 2026 14:47:36 +0900 Subject: [PATCH 2/4] fix replace with api_version Signed-off-by: Takio Yamaoka --- .../device/services/device-onvif-camera/swagger.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs_src/microservices/device/services/device-onvif-camera/swagger.md b/docs_src/microservices/device/services/device-onvif-camera/swagger.md index 2f85a3301..24dfb1391 100644 --- a/docs_src/microservices/device/services/device-onvif-camera/swagger.md +++ b/docs_src/microservices/device/services/device-onvif-camera/swagger.md @@ -2,4 +2,4 @@ Use this RESTful API documentation to learn more about the capabilities of the device service. - + From 50fd319cc924729d40193ff27b0ed45bddbcc110 Mon Sep 17 00:00:00 2001 From: Takio Yamaoka Date: Mon, 27 Apr 2026 14:49:11 +0900 Subject: [PATCH 3/4] fix non-secure mode Signed-off-by: Takio Yamaoka --- .../Walkthrough/deployment.md | 60 +++++++++++++------ 1 file changed, 42 insertions(+), 18 deletions(-) diff --git a/docs_src/microservices/device/services/device-onvif-camera/Walkthrough/deployment.md b/docs_src/microservices/device/services/device-onvif-camera/Walkthrough/deployment.md index 435cfc1d8..5a2dd77fb 100644 --- a/docs_src/microservices/device/services/device-onvif-camera/Walkthrough/deployment.md +++ b/docs_src/microservices/device/services/device-onvif-camera/Walkthrough/deployment.md @@ -226,19 +226,30 @@ Follow this guide to deploy and run the service. Figure 4: EdgeX Console Device Profile List

-Additionally, ensure that the service config has been deployed and that Consul is reachable. +Additionally, ensure that the service config has been deployed and that Core-Keeper is reachable. !!! note If running in secure mode this command needs the [Consul ACL token](#token-generation-secure-mode-only) generated previously. ```bash -curl -H "X-Consul-Token:" -X GET "http://localhost:8500/v1/kv/edgex/{{api_version}}/device-onvif-camera?keys=true" +curl -sH "X-Consul-Token:" -X GET "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{edgexversion}}/device-onvif-camera?keyOnly=true" | jq -r ".response" ``` Example output: ```bash -["edgex/v3/device-onvif-camera/AppCustom/BaseNotificationURL", "edgex/v3/device-onvif-camera/AppCustom/CheckStatusInterval", - "edgex/v3/device-onvif-camera/AppCustom/CredentialsMap/NoAuth", ... , "edgex/v3/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretData/username", "edgex/v3/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretName", - "edgex/v3/device-onvif-camera/Writable/LogLevel"] +[ + "edgex/v4/device-onvif-camera/Writable/LogLevel", + "edgex/v4/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretName", + "edgex/v4/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretData/username", + "edgex/v4/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretData/password", + "edgex/v4/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretData/mode", + "edgex/v4/device-onvif-camera/Writable/InsecureSecrets/credentials002/SecretName", + "edgex/v4/device-onvif-camera/Writable/InsecureSecrets/credentials002/SecretData/mode", + ... + "edgex/v4/device-onvif-camera/AppCustom/CredentialsMap/NoAuth", + "edgex/v4/device-onvif-camera/AppCustom/RequestTimeout", + "edgex/v4/device-onvif-camera/AppCustom/DiscoveryMode", + "edgex/v4/device-onvif-camera/AppCustom/DiscoverySubnets" +] ``` ## Manage Devices @@ -273,7 +284,7 @@ Follow these instructions to add and update devices manually. "protocols": { "Onvif": { "Address": "10.0.0.0", - "Port": "10000", + "Port": "2020", "MACAddress": "aa:bb:cc:11:22:33", "FriendlyName":"Default Camera" }, @@ -403,34 +414,48 @@ Follow these instructions to add and update devices manually. If you want to map multiple mac addresses, enter a comma separated list in the command ```bash - curl --data '' -X PUT "http://localhost:8500/v1/kv/edgex/{{api_version}}/device-onvif-camera/AppCustom/CredentialsMap/" + curl --data '{ "value": "" }' -X PUT "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{edgexversion}}/device-onvif-camera/AppCustom/CredentialsMap/" ``` Example output: ```bash - true + {"apiVersion":"v3","statusCode":200,"response":["edgex/v4/device-onvif-camera/AppCustom/CredentialsMap/"]} ``` b. Check the status of the credentials map. ```bash - curl -X GET "http://localhost:8500/v1/kv/edgex/{{api_version}}/device-onvif-camera/AppCustom/CredentialsMap?keys=true" | jq . + curl -X GET "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{edgexversion}}/device-onvif-camera/AppCustom/CredentialsMap?keyOnly=true&plaintext=true" | jq . ``` Example output: ```bash - [ - "edgex/{{api_version}}/device-onvif-camera/AppCustom/CredentialsMap/NoAuth", - "edgex/{{api_version}}/device-onvif-camera/AppCustom/CredentialsMap/credentials001", - "edgex/{{api_version}}/device-onvif-camera/AppCustom/CredentialsMap/credentials002" - ] + { + "apiVersion": "v3", + "statusCode": 200, + "response": [ + "edgex/v4/device-onvif-camera/AppCustom/CredentialsMap/NoAuth", + "edgex/v4/device-onvif-camera/AppCustom/CredentialsMap/" + ] + } ``` c. Check the mac addresses mapped to a specific credenential name. Insert the credential name in the command to see the mac addresses associated with it. ```bash - curl -X GET "http://localhost:8500/v1/kv/edgex/{{api_version}}/device-onvif-camera/AppCustom/CredentialsMap/?raw=true" + curl -sX GET "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{edgexversion}}/device-onvif-camera/AppCustom/CredentialsMap/?plaintext=true" | jq . ``` Example response: ```bash - 11:22:33:44:55:66 + { + "apiVersion": "v3", + "statusCode": 200, + "response": [ + { + "key": "edgex/v4/device-onvif-camera/AppCustom/CredentialsMap/", + "Created": 1777267786001, + "Modified": 1777267786001, + "value": "" + } + ] + } ``` !!! note @@ -445,7 +470,6 @@ Follow these instructions to add and update devices manually. Example output: ```bash deviceName: Camera001 - deviceName: device-onvif-camera ``` !!! note @@ -453,7 +477,7 @@ Follow these instructions to add and update devices manually. #### Update Device - There are multiple commands that can update aspects of the camera entry in meta-data. Refer to the [Swagger documentation](./general-usage.md) for Core Metadata for more information. For editing specific fields, see the [General Usage](./general-usage.md) tab. + There are multiple commands that can update aspects of the camera entry in meta-data. Refer to the [Swagger documentation](../swagger.md) for Core Metadata for more information. For editing specific fields, see the [General Usage](./general-usage.md) tab. #### Delete Device From cf295ad255afcf894a926c19162c6bff11878670 Mon Sep 17 00:00:00 2001 From: Takio Yamaoka Date: Mon, 27 Apr 2026 15:31:38 +0900 Subject: [PATCH 4/4] fix replace with config_version Signed-off-by: Takio Yamaoka --- .../Walkthrough/deployment.md | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docs_src/microservices/device/services/device-onvif-camera/Walkthrough/deployment.md b/docs_src/microservices/device/services/device-onvif-camera/Walkthrough/deployment.md index 5a2dd77fb..3242f8617 100644 --- a/docs_src/microservices/device/services/device-onvif-camera/Walkthrough/deployment.md +++ b/docs_src/microservices/device/services/device-onvif-camera/Walkthrough/deployment.md @@ -231,24 +231,24 @@ Additionally, ensure that the service config has been deployed and that Core-Kee If running in secure mode this command needs the [Consul ACL token](#token-generation-secure-mode-only) generated previously. ```bash -curl -sH "X-Consul-Token:" -X GET "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{edgexversion}}/device-onvif-camera?keyOnly=true" | jq -r ".response" +curl -sH "X-Consul-Token:" -X GET "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{config_version}}/device-onvif-camera?keyOnly=true" | jq -r ".response" ``` Example output: ```bash [ - "edgex/v4/device-onvif-camera/Writable/LogLevel", - "edgex/v4/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretName", - "edgex/v4/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretData/username", - "edgex/v4/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretData/password", - "edgex/v4/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretData/mode", - "edgex/v4/device-onvif-camera/Writable/InsecureSecrets/credentials002/SecretName", - "edgex/v4/device-onvif-camera/Writable/InsecureSecrets/credentials002/SecretData/mode", + "edgex/{{config_version}}/device-onvif-camera/Writable/LogLevel", + "edgex/{{config_version}}/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretName", + "edgex/{{config_version}}/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretData/username", + "edgex/{{config_version}}/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretData/password", + "edgex/{{config_version}}/device-onvif-camera/Writable/InsecureSecrets/credentials001/SecretData/mode", + "edgex/{{config_version}}/device-onvif-camera/Writable/InsecureSecrets/credentials002/SecretName", + "edgex/{{config_version}}/device-onvif-camera/Writable/InsecureSecrets/credentials002/SecretData/mode", ... - "edgex/v4/device-onvif-camera/AppCustom/CredentialsMap/NoAuth", - "edgex/v4/device-onvif-camera/AppCustom/RequestTimeout", - "edgex/v4/device-onvif-camera/AppCustom/DiscoveryMode", - "edgex/v4/device-onvif-camera/AppCustom/DiscoverySubnets" + "edgex/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap/NoAuth", + "edgex/{{config_version}}/device-onvif-camera/AppCustom/RequestTimeout", + "edgex/{{config_version}}/device-onvif-camera/AppCustom/DiscoveryMode", + "edgex/{{config_version}}/device-onvif-camera/AppCustom/DiscoverySubnets" ] ``` @@ -414,17 +414,17 @@ Follow these instructions to add and update devices manually. If you want to map multiple mac addresses, enter a comma separated list in the command ```bash - curl --data '{ "value": "" }' -X PUT "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{edgexversion}}/device-onvif-camera/AppCustom/CredentialsMap/" + curl --data '{ "value": "" }' -X PUT "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap/" ``` Example output: ```bash - {"apiVersion":"v3","statusCode":200,"response":["edgex/v4/device-onvif-camera/AppCustom/CredentialsMap/"]} + {"apiVersion":"v3","statusCode":200,"response":["edgex/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap/"]} ``` b. Check the status of the credentials map. ```bash - curl -X GET "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{edgexversion}}/device-onvif-camera/AppCustom/CredentialsMap?keyOnly=true&plaintext=true" | jq . + curl -X GET "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap?keyOnly=true&plaintext=true" | jq . ``` Example output: ```bash @@ -432,15 +432,15 @@ Follow these instructions to add and update devices manually. "apiVersion": "v3", "statusCode": 200, "response": [ - "edgex/v4/device-onvif-camera/AppCustom/CredentialsMap/NoAuth", - "edgex/v4/device-onvif-camera/AppCustom/CredentialsMap/" + "edgex/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap/NoAuth", + "edgex/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap/" ] } ``` c. Check the mac addresses mapped to a specific credenential name. Insert the credential name in the command to see the mac addresses associated with it. ```bash - curl -sX GET "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{edgexversion}}/device-onvif-camera/AppCustom/CredentialsMap/?plaintext=true" | jq . + curl -sX GET "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap/?plaintext=true" | jq . ``` Example response: ```bash @@ -449,7 +449,7 @@ Follow these instructions to add and update devices manually. "statusCode": 200, "response": [ { - "key": "edgex/v4/device-onvif-camera/AppCustom/CredentialsMap/", + "key": "edgex/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap/", "Created": 1777267786001, "Modified": 1777267786001, "value": ""