# Bitpool Edge Uploader

## **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](https://wiki.bitpool.com/edge/apps/bitpool-edge/bitpool-edge-installation) 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-uploader` and install the module once displayed.
4. Finally, use the left most navigation menu to scroll down to the heading `Bitpool Uploader` to reveal available nodes<br>

### **Docker Install** :whale:

This Edge-Uploader 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](https://wiki.bitpool.com/bitpool-edge/bitpool-edge-installation).

### **Uploader Nodes**

The Uploader library of nodes is broken down into 2x functional blocks.

![](https://3902784585-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F28eeWKJBGNSvwO7hWa0f%2Fuploads%2F1x4olYszDqho4Z6R1IUj%2Fimage.png?alt=media\&token=60b199c4-d7ee-4a7b-a8b8-810a02825658)

1. `uploader` - interacts with the bitpool cloud, creating pools, streams, and uploading data.
2. `metatag` - appends tags to the node red msg object, and forwards the tags to the uploader node. This enriches the data getting uploaded to the bitpool cloud&#x20;

### **Further Information**

Now that your Bitpool-Edge is up and running, we have included simple examples 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-uploader` to reveal the preconfigured examples.
4. Click the example you would like to test the 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!*