diff --git a/README.md b/README.md index 5e353390..3bc70e3c 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,64 @@ # Azure IoT Plug and Play (PnP) Device Explorer + [![Build Status](https://dev.azure.com/azure/azure-iot-explorer/_apis/build/status/Azure%20IoT%20Explorer%20CI%20Pipeline?branchName=master)](https://dev.azure.com/azure/azure-iot-explorer/_build/latest?definitionId=31&branchName=master) ## Table of Contents -- [Overview](#overview) -- [Development Setup](#development-setup) + +- [Getting Azure IoT explorer](#getting-azure-iot-explorer) +- [Features](#features) - [Contributing](#contributing) -## Overview +## Getting Azure IoT explorer -This application provides users an easy and visualized way to interact with Azure IoT devices. +You can either download a pre-built version or build it yourself. -1. Go to the releases tab, download the installer corresponding to your platform and install. -1. Fill in IoT Hub connection string and that's it. +### Download a pre-built version -![image](https://user-images.githubusercontent.com/5489222/61984482-6af89f80-afb9-11e9-8b2f-d6905301d9a9.png) +Go to the [Releases](https://github.com/Azure/azure-iot-explorer/releases) tab, download the installer corresponding to your platform and install. -## Development Setup +### Run it locally and build it yourself -### Setup 1. Open a Node capable command prompt -1. git clone https://github.com/Azure/azure-iot-explorer.git -1. run `npm install` -1. run `npm start`. A new tab in your default browser will be opened automatically and site would be running locally -1. (optional) stop step 3, run `npm run build` and then run `npm run electron`. The electron app would start locally using the bits generated in the dist folder +1. Clone the repo: `git clone https://github.com/Azure/azure-iot-explorer.git` +1. Run: `npm install` +1. Run: `npm start` + - A new tab in your default browser will be opened automatically pointing to the locally running site. +1. [optional] Stop step 4 then run: `npm run build` and then run: `npm run electron`. + - The electron app will spin up using the bits generated in the dist folder. -If you'd like to package the app yourself, please refer to [FAQ](https://github.com/Azure/azure-iot-explorer/wiki/FAQ) +If you'd like to package the app yourself, please refer to the [FAQ](https://github.com/Azure/azure-iot-explorer/wiki/FAQ). + +## Features + +### Configure an IoT Hub connection + +- After opening the application, add the connection string for your IoT Hub, then click **Connect**. + +login + +### Manage devices + +- Click **New** to create a new device. +- Select device(s) and click **Delete** to delete device(s). Multiple devices can be selected by clicking while dragging the mouse. +- Devices can by queried by typing the first few characters of a device name in the query box. + +manage_devices + +- Click on the device name to see the device details and interact with the device. + +device_details + +### Manage Plug and Play devices + +- Open the **Settings** panel to configure how PnP Model definitions can be resolved. For more information on PnP devices, please visit [Microsoft Docs](https://docs.microsoft.com/en-us/azure/iot-pnp/overview-iot-plug-and-play). + +settings + +- Go to the device details page by clicking the name of a PnP device. +- Interfaces implemented by the PnP device would be populated under the DIGITAL TWIN section of the left navigation bar. Open interface, properties, commands or telemetry to start interacting with the PnP device. + +pnp_device_details ## Contributing diff --git a/doc/screenshots/device_details.PNG b/doc/screenshots/device_details.PNG new file mode 100644 index 00000000..c2fd3f1b Binary files /dev/null and b/doc/screenshots/device_details.PNG differ diff --git a/doc/screenshots/login.PNG b/doc/screenshots/login.PNG new file mode 100644 index 00000000..23dcf7f6 Binary files /dev/null and b/doc/screenshots/login.PNG differ diff --git a/doc/screenshots/manage_devices.PNG b/doc/screenshots/manage_devices.PNG new file mode 100644 index 00000000..d26a1383 Binary files /dev/null and b/doc/screenshots/manage_devices.PNG differ diff --git a/doc/screenshots/pnp_device_details.PNG b/doc/screenshots/pnp_device_details.PNG new file mode 100644 index 00000000..632e46f2 Binary files /dev/null and b/doc/screenshots/pnp_device_details.PNG differ diff --git a/doc/screenshots/settings.PNG b/doc/screenshots/settings.PNG new file mode 100644 index 00000000..4386bb85 Binary files /dev/null and b/doc/screenshots/settings.PNG differ