Skip to content

Latest commit

 

History

History
105 lines (69 loc) · 6.04 KB

README.md

File metadata and controls

105 lines (69 loc) · 6.04 KB
Raw

LVA Edge Graph Extension for VS Code

Live Video Analytics on IoT Edge (LVA Edge) support for Visual Studio Code is provided through this extension that makes it easy to edit and manage LVA Edge media graphs.

What's New (v0.1.2)

Changed

  • Fixed a bug, where manually adding parameters is causing failures saving a graph
  • Fixed bug when changing orientation on the graph
  • Allowing negative values for some properties

What's New (v0.1.1)

Changed

  • Fixed a bug, where node name updates was affecting other nodes with same name

What's New (v0.1.0)

Added

  • Create and manage LVA Edge 2.0.0 module media graphs

Suggested Pre-reading

Prerequisites

  • An Azure account that has an active subscription.
  • Azure IoT Tools extension
  • This extension also requires the following Azure resources:
    • IoT Hub
    • Storage account
    • Azure Media Services account
    • A Linux VM in Azure, with IoT Edge runtime installed which will act as an IoT Edge device
    • IoT Edge modules deployed to the IoT Edge device
      • edgeAgent
      • edgeHub
      • Live Video Analytics agent

On first run, you need to connect to an Azure IoT Hub using a connection string. You can then manage graph topologies and instances on the chosen device. You can get a connection string by following the instructions in the Quickstart. Follow the steps up until Configure the Azure IoT Tools extension and use the connection string in this extension instead of Azure IoT Tools.

Setup LVA edge graph extension

After successfully installing this extension and its prerequisites, you can follow the steps below to get started with Live Video on Analytics on IoT Edge devices.

Connect to the IoT Hub

You will need to use the IoT Hub connection string to connect this extension to it.

  1. In Explorer of VS Code, click the "Live Video Analytics" extension in the left pane.

  2. Click on "Enter Connection String" button

    • Enter the Iot Hub Connection string that you want use (It is one-time configuration, and please make sure it is IoT Hub Connection String and not Device Connection String. The format is HostName=<my-hub>.azure-devices.net;SharedAccessKeyName=<my-policy>;SharedAccessKey=<my-policy-key>)

Setup IoT Hub Connection String

  1. The device list will be shown
    • Choose the device you want to use to deploy the media graphs
  2. A list of modules that are already deployed to the device will be displayed
    • Choose the Live Video Analytics module from the list
  3. Open the VS Code Explorer or press Ctrl+ Shift + E and search for the Azure IoT hub extension at the bottom left pane
  4. Pull up the extension and find the IoT Hub
  5. Right click the ... button and select "Start Monitoring Built-in Event Endpoint" option

Create Graph Topologies

  1. Expand the Devices, Modules and the Live Video Analytics module nodes in the left pane
  2. Click the + icon next to "Graph Topologies"
  3. A panel will open on the right that will help you in creating a graph topology
  4. You will start by providing a "Topology name"
  5. You can either create a new topology by dragging and dropping the topology components available in the left panel
  6. Or, you can try out some sample topologies that we have created by clicking the "Try sample topologies" in the top menu bar
  7. Once you are done creating the topology and providing values for the required fields, save the topology by clicking the "Save" button
  8. You should then see the topology name in the left pane

Create a graph topology

Activate Graph Instances

  1. Once a graph topology is created, you need to create an instance of the topology
    • Here you will provide the values to the graph instance parameters
  2. Once all the required parameters are filled in, you can "Save" the instance and activate it later or "Save and activate" the graph instance
  3. Once the graph is activated, you will see a green icon next to the graph instance name
  4. Open the Output console by pressing Ctrl+ Shift + U and observe the IoT Hub messages start flowing

Activate an graph instance

Contributing

Got a suggestion for the Azure IoT Tools extension? Submit a new issue and a PR with an updated package.json and README.md and we'll take a look!

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

License

MIT