Skip to content

Commit

Permalink
update readme with new images (#284)
Browse files Browse the repository at this point in the history
  • Loading branch information
YingXue authored May 12, 2020
1 parent 3a8fa58 commit 6cb63eb
Show file tree
Hide file tree
Showing 12 changed files with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,36 +33,38 @@ If you'd like to package the app yourself, please refer to the [FAQ](https://git

### Configure an IoT Hub connection

- After opening the application, add the connection string for your IoT Hub, then click **Connect**.
- Upon opening the application, add the connection string of your IoT hub. You can add multiple strings, view, update or detete them anytime by returning to Home.

<img src="doc/screenshots/login.PNG" alt="login" width="800"/>
<img src="doc/screenRecords/login.gif" alt="login" width="800"/>

### Manage devices
### Device CRUD

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

<img src="doc/screenshots/manage_devices.PNG" alt="manage_devices" width="800"/>
<img src="doc/screenRecords/create_device.gif" alt="create_device" width="800"/>

### Device functionalities
- Click on the device name to see the device details and interact with the device.
- Check out the [list of features that we support](https://github.com/Azure/azure-iot-explorer/wiki)

<img src="doc/screenshots/device_details.PNG" alt="device_details" width="800"/>
<img src="doc/screenshots/device_details.JPG" alt="device_details" width="800"/>

### Manage Plug and Play devices
### Plug and Play Preview

- 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).
**If you are looking for a UI tool to get a flavor of Plug and Play, look no futher. Follow this [Microsoft Docs](https://docs.microsoft.com/en-us/azure/iot-pnp/overview-iot-plug-and-play) to get started.**
- Once your device has gone through discovery, **IoT Plug and Play components** page would be available on device details view.
- The model ID would be shown.
- Follow our guidance to set up how we can retrieve model definitions. If it is already setup, We will inform you where are we resolving your model defintions from.
- A table would show the list of components implemented by the device and the corresponding interfaces the components conform to.
- You can go back to Home (either from device or by directly clicking the breadcrum) to change how we resolve model definitions. Note this is a global setting which would affect across the hub.

<img src="doc/screenshots/settings.PNG" alt="settings" width="400"/>

- Go to the device details page by clicking the name of a PnP device.
- Click Plug and Play from the navigation. If the device is a Plug and Play device, the Device capability model ID would be shown. A table would show the list of components implemented by the device and the corresponding interfaces the components conform to.

<img src="doc/screenshots/pnp_interfaces.PNG" alt="settings" width="800"/>
<img src="doc/screenRecords/pnp_discovery.gif" alt="pnp_discovery" width="800"/>

- Click the name of any component, and switch between interface, properties, commands and telemetry to start interacting with the PnP device.

<img src="doc/screenshots/pnp_device_details.PNG" alt="pnp_device_details" width="800"/>
<img src="doc/screenRecords/pnp_interaction.gif" alt="pnp_interaction" width="800"/>

## Contributing

Expand Down
Binary file added doc/screenRecords/create_device.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/screenRecords/login.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/screenRecords/pnp_discovery.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/screenRecords/pnp_interaction.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/screenshots/device_details.JPG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/screenshots/device_details.PNG
Binary file not shown.
Binary file removed doc/screenshots/login.PNG
Binary file not shown.
Binary file removed doc/screenshots/manage_devices.PNG
Binary file not shown.
Binary file removed doc/screenshots/pnp_device_details.PNG
Binary file not shown.
Binary file removed doc/screenshots/pnp_interfaces.PNG
Binary file not shown.
Binary file removed doc/screenshots/settings.PNG
Binary file not shown.

0 comments on commit 6cb63eb

Please sign in to comment.