You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Purpose
Clarify instructions in PTZ demo readme
## Does this introduce a breaking change?
[ ] Yes
[x] No
```
## Pull Request Type
What kind of change does this Pull Request introduce?
```
[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[x] Documentation content changes
[ ] Other... Please describe:
```
Copy file name to clipboardExpand all lines: samples/aio-onvif-connector-ptz-demo/README.md
+15-13Lines changed: 15 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,27 @@
1
-
# AIO ONVIF Connector PTZ Demo
1
+
# Azure IoT Operations ONVIF Connector PTZ Demo
2
2
3
-
## MRPC Sample Application
3
+
## MRPC sample application
4
4
5
-
This sample application demonstrates how to use the MRPC API provided by ONVIF Connector to interact with an ONVIF device. The sample consists of 3 dotnet assemblies:
6
-
- PTZClient: This assembly contains code to interact with the PTZ service of an ONVIF device. It is generated from the PTZ service DTDL file.
7
-
- MediaClient: This assembly contains code to interact with the media service of an ONVIF device. It is generated from the media service DTDL file.
5
+
This sample application demonstrates how to use the MRPC API provided by the connector for ONVIF to interact with an ONVIF device. The sample consists of 3 dotnet assemblies:
6
+
- PTZClient: This assembly contains code to interact with the PTZ service of an ONVIF device. It's generated from the PTZ service DTDL file.
7
+
- MediaClient: This assembly contains code to interact with the media service of an ONVIF device. It's generated from the media service DTDL file.
8
8
- Aio.Onvif.Connector.Ptz.Demo: A simple console application that demonstrates how to use the PTZ assembly to move the camera.
9
9
10
-
## Build instructions
10
+
## Prerequisites
11
11
12
-
Make sure you have the .NET 9.0 SDK installed. You can download it from [here](https://dotnet.microsoft.com/download).
12
+
### .NET SDK
13
13
14
-
Once installed open this directory in your terminal and run `dotnet build`
14
+
Make sure you have the .NET 9.0 SDK installed. You can download it from [Download .NET](https://dotnet.microsoft.com/download).
15
15
16
-
## Prerequisites
16
+
After it's installed, open this directory in your terminal and run `dotnet build`
17
17
18
18
### Create the asset endpoint and assets
19
19
20
20
To create the asset endpoint and assets that the sample application interacts with, follow the steps in [Configure the connector for ONVIF (preview)](https://learn.microsoft.com/azure/iot-operations/discover-manage-assets/howto-use-onvif-connector).
21
21
22
22
The how-to guide walks you through the steps to create:
23
23
24
-
- The `my-onvif-camera` device with a inbound endpoint called `onvifep`
24
+
- The `my-onvif-camera` device with a inbound endpoint called `my-onvif-device-0`
25
25
- The discovered ONVIF and media assets
26
26
27
27
### Create Broker Listener
@@ -47,6 +47,8 @@ Execute the following to apply it to the cluster:
Note: This configuration isn't secure and is only suitable in test and development environments. It enables an external client to connect to the internal MQTT broker without any credentials.
51
+
50
52
### Port Forward Broker Listener
51
53
52
54
Port forward the broker listener to your local machine in a second terminal:
@@ -59,11 +61,11 @@ Leave this open to keep the port forward active.
59
61
60
62
## Run instructions
61
63
62
-
Start the application by running `dotnet run --project Aio.Onvif.Connector.Ptz.Demo -- --mqtt-host localhost --mqtt-port 1883 --namespace azure-iot-operations --ptz-asset <your ONVIF asset name> --media-asset <your media asset name> --mode relative`
64
+
Start the application by running `dotnet run --project Aio.Onvif.Connector.Ptz.Demo --mqtt-host localhost --mqtt-port 1883 --namespace azure-iot-operations --asset <your ONVIF asset name> --mode relative`
63
65
64
-
After entering this information, the application will connect to the AIO Broker and the camera can be moved with keyboard input. Press 'q' to exit the application.
66
+
After entering this information, the application connects to the AIO Broker and the camera can be moved with keyboard input. Press 'q' to exit the application.
65
67
66
-
This example uses RelativeMove by default. Depending on the camera, you may need to use ContinuousMove instead. To do this, add the `--mode continuous` option when starting the application.
68
+
This example uses `RelativeMove` by default. Depending on the camera, you may need to use `ContinuousMove` instead. To do this, add the `--mode continuous` option when starting the application.
0 commit comments