Skip to content

Commit

Permalink
lgtm
Browse files Browse the repository at this point in the history
  • Loading branch information
dcmartin committed Aug 23, 2020
1 parent 15cfa6c commit dd7937f
Show file tree
Hide file tree
Showing 13 changed files with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/ABOUT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,54 +6,54 @@ Add the _addon_'s Github [repository](http://github.com/dcmartin/hassio-addons)

The Supervisor _Dashboard_ displays any installed _addons_ with indications for status and upgrade.

<img src="supervisor-dashboard.png" width=512>
<img src="https://raw.githubusercontent.com/dcmartin/addons/master/docs/samples/supervisor-dashboard.png" width=512>

The Supervisor _Add-on store_ displays _addons_ available from configured repositories.

<img src="supervisor-add-on-store.png" width=512>
<img src="https://raw.githubusercontent.com/dcmartin/addons/master/docs/samples/supervisor-add-on-store.png" width=512>

Additional repositories may be added (n.b control element, upper-right corner)

<img src="supervisor-manage-repositories.png" width=512>
<img src="https://raw.githubusercontent.com/dcmartin/addons/master/docs/samples/supervisor-manage-repositories.png" width=512>

For example: `http://github.com/dcmartin/hassio-addons`

<img src="supervisor-add-on-store-repositories.png" width=512>
<img src="https://raw.githubusercontent.com/dcmartin/addons/master/docs/samples/supervisor-add-on-store-repositories.png" width=512>

The _addons_ from the added repository are displayed in the _Add-on store_:

<img src="dcmartin-addons.png" width=512>
<img src="https://raw.githubusercontent.com/dcmartin/addons/master/docs/samples/dcmartin-addons.png" width=512>

## Step 2: Install `ambianic`
Install the _addon_ and the Home Assistant supervisor will download the appropriate Docker container from [Docker Hub](http://hub.docker.com/); for example the [`armv7`](https://hub.docker.com/repository/docker/dcmartin/armv7-addon-ambianic) version for RaspberryPi.

<img src="ambianic-addon-not-installed.png" width=512>
<img src="samples/ambianic-addon-not-installed.png" width=512>


After installation -- which may require significant time depending on network speed -- the _addon_ should be configured with the _sources_ and other options and started. See the [DOCS.md](../DOCS.md) file for more information on configuration options.

<img src="ambianic-addon-installed.png" width=512>
<img src="samples/ambianic-addon-installed.png" width=512>

When an update to an _addon_ is available, a notification is provided.

<img src="ambianic-addon-update-available.png" width=512>
<img src="samples/ambianic-addon-update-available.png" width=512>

## Step 3: Browse to `ui.ambianic.ai`
The Ambianic Edge software communicates using `WebRTC` to a progressive Web application (PWA) that provides the user-interface. The PWA provides for _settings_ to establish the peer-to-peer (P2P) connection between the edge device and the Web browser.

Using a Web browser, navigate to `https://ui.ambianic.ai` (**note**: `SSL/TLS`) and the PWA will load and provide access to the controls (n.b. on the left-side).

<img src="ambianic-pwa-controls.png" width=256>
<img src="samples/ambianic-pwa-controls.png" width=256>

The PWA connects to the edge device through a redezvous on the local area network (LAN) requiring both the Web browser and the edge device to be on the same LAN for initiation.

<img src="ambianic-pwa-settings-start.png" width=384>
<img src="samples/ambianic-pwa-settings-start.png" width=384>

Once the P2P connection is established it will be maintained even when the Web browser is not on the same LAN.

<img src="ambianic-pwa-settings-complete.png" width=384>
<img src="samples/ambianic-pwa-settings-complete.png" width=384>

The PWA provides a _timeline_ of _events_, e.g. `Object Detection`, and displays them chronologically with the latest at the top.

<img src="ambianic-pwa-operational.png" width=384>
<img src="samples/ambianic-pwa-operational.png" width=384>

Binary file removed docs/dcmartin-addons.png
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file removed docs/supervisor-add-on-store-repositories.png
Binary file not shown.
Binary file removed docs/supervisor-add-on-store.png
Binary file not shown.
Binary file removed docs/supervisor-dashboard.png
Binary file not shown.
Binary file removed docs/supervisor-manage-repositories.png
Binary file not shown.

0 comments on commit dd7937f

Please sign in to comment.