# Bitpool Edge Awair

## Getting Started

This is a standard Node.js module developed specifically to function within the Node-RED ecosystem.

## How to Use

Use the following procedure to install this module to your Node-RED instance, or download the pre-themed Bitpool-Edge Docker image that contains all our favourite nodes pre-installed.

### Bitpool-Edge Install

1. Log into your Bitpool-Edge instance and click the `Hamburger` icon, in the top-right corner.
2. Select `Manage Palette` from the drop down menu then click the `Pallete->Install` tabs to install.
3. Using the search bar type `@bitpoolos/edge-awair` and install the module once displayed.
4. Finally, use the left most navigation menu to scroll down to the heading `Bitpool Awair` to reveal available nodes.

### Docker Install :whale:

This Awair module and many other Bitpool developed nodes have been pre-installed for your convenience in a Bitpool themed Node-RED application.

Go here for how to install Bitpool-Edge.

### Awair Nodes

The Awair library contains a single node / functional block. 

<figure><img src="https://3902784585-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F28eeWKJBGNSvwO7hWa0f%2Fuploads%2FWuviZU9aLUBi7XZpvFOb%2Fimage.png?alt=media&#x26;token=60e11f0b-1771-40fb-804d-861c13f54d56" alt=""><figcaption></figcaption></figure>

1. `Awair Device` - Allows for the connection to a device in the Awair Cloud and returns the latest available air data for that device.

### Basic Workflow

<figure><img src="https://3902784585-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F28eeWKJBGNSvwO7hWa0f%2Fuploads%2F1U5OCQFtliR1njmkXGnO%2Fimage.png?alt=media&#x26;token=d43ae1ef-7e05-49f3-93bb-3502163f632e" alt=""><figcaption></figcaption></figure>

The image above is an example of a linked Awair Device node on a Flow tab. This is the basic flow of data.

1. The ‘Trigger’ node injects a simple timestamp into the `Awair Device` node.
2. The `Awair Device` node contains an API configuration along with a device selection which is used to retireve the latest air data for the device.
3. Finally, the `Output` node prints the payload to the debug tab for the user to see.

### Further Information

Now that your Bitpool-Edge is up and running, we have included simple example flows to demonstrate how to create a basic solution.

1. Log into your Bitpool-Edge instance and click the `Hamburger` icon, in the top-right corner.
2. Select `Manage Palette` from the drop down menu then click the `Import->Examples` tabs to see this node.
3. Navigate the ‘Examples flows’ tree and select `@bitpoolos/edge-awair` to reveal the preconfigured examples.
4. Click the example you would like to test then click the `Import` button.
5. Place the example nodes on a flow and review the configuration of each node. You will need to make suitable changes for your system.
6. Finally, click the `Save` to test.

> Additionally, there is basic helper documentation on each node. Just select a target node and click the `Help` tab found at the top right corner of Bitpool-Edge.
>
> **Hint** *- the icon looks like a book!*