Skip to content

fix(microservices): update ONVIF Camera documents #1486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ytakio wants to merge 4 commits into
base: main
Choose a base branch
from
+44 −19
Open

fix(microservices): update ONVIF Camera documents #1486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0c52e46
fix miss link of openapi of onvif-camera
ytakio Apr 27, 2026
3b629f2
fix replace with api_version
ytakio Apr 27, 2026
50fd319
fix non-secure mode
ytakio Apr 27, 2026
cf295ad
fix replace with config_version
ytakio Apr 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 42 additions & 18 deletions ...src/microservices/device/services/device-onvif-camera/Walkthrough/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,19 +226,30 @@ Follow this guide to deploy and run the service.
<i>Figure 4: EdgeX Console Device Profile List</i>
</p>

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:<consul-token>" -X GET "http://localhost:8500/v1/kv/edgex/{{api_version}}/device-onvif-camera?keys=true"
curl -sH "X-Consul-Token:<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/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/{{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/{{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"
]
```

## Manage Devices
Expand Down Expand Up @@ -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"
},
Expand Down Expand Up @@ -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 '<mac-address>' -X PUT "http://localhost:8500/v1/kv/edgex/{{api_version}}/device-onvif-camera/AppCustom/CredentialsMap/<creds-name>"
curl --data '{ "value": "<mac-address>" }' -X PUT "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap/<creds-name>"
```

Example output:
```bash
true
{"apiVersion":"v3","statusCode":200,"response":["edgex/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap/<creds-name>"]}
```

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/{{config_version}}/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/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap/NoAuth",
"edgex/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap/<creds-name>"
]
}
```

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/<creds-name>?raw=true"
curl -sX GET "http://localhost:59890/api/{{api_version}}/kvs/key/edgex/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap/<creds-name>?plaintext=true" | jq .
```
Example response:
```bash
11:22:33:44:55:66
{
"apiVersion": "v3",
"statusCode": 200,
"response": [
{
"key": "edgex/{{config_version}}/device-onvif-camera/AppCustom/CredentialsMap/<creds-name>",
"Created": 1777267786001,
"Modified": 1777267786001,
"value": "<mac-address>"
}
]
}
```

!!! note
Expand All @@ -445,15 +470,14 @@ Follow these instructions to add and update devices manually.
Example output:
```bash
deviceName: Camera001
deviceName: device-onvif-camera
```

!!! note
`jq -r` is used to reduce the size of the displayed response. The entire device with all information can be seen by removing `-r '"deviceName: " + '.devices[].name'', and replacing it with '.'`

#### 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

Expand Down
3 changes: 2 additions & 1 deletion docs_src/microservices/device/services/device-onvif-camera/swagger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Device ONVIF Swagger API Documentation

Use this RESTful API documentation to learn more about the capabilities of the device service.

<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/device-onvif-camera/{{edgexversion}}/doc/openapi/device-onvif-camera.yaml"/>
<swagger-ui src="https://raw.githubusercontent.com/edgexfoundry/device-onvif-camera/{{edgexversion}}/doc/openapi/{{api_version}}/device-onvif-camera.yaml"/>