Skip to content

Commit

Permalink
run format
Browse files Browse the repository at this point in the history
  • Loading branch information
lucarin91 committed Dec 4, 2024
1 parent 7447cdc commit f922030
Show file tree
Hide file tree
Showing 9 changed files with 1,431 additions and 954 deletions.
48 changes: 31 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,63 +4,77 @@ This module implements Node-RED nodes for interacting with [Arduino IoT Cloud](h
Multi Arduino Accounts are allowed.

## Docker and Node-RED installation

The easiest way to install Docker on a linux system is to use [the convenience script](https://docs.docker.com/engine/install/ubuntu/#install-using-the-convenience-script):

```shell
curl -sSL https://get.docker.com/ | sh
```

To install Node-RED you can use the [official docker container](https://hub.docker.com/r/nodered/node-red):

```shell
docker run -it -p 1880:1880 -v myNodeREDdata:/data --name mynodered nodered/node-red
```


## Installation
Just search *node-red-contrib-arduino-iot-cloud* in the Node-RED palette manager and click on install

Just search _node-red-contrib-arduino-iot-cloud_ in the Node-RED palette manager and click on install

Or you can install the plugin by using `npm` in your `$HOME/.node-red` directory:

`npm install @arduino/node-red-contrib-arduino-iot-cloud`

### Update
If you're using a service hosting your node-red instance and you want to be sure that you're using the latest version of *node-red-contrib-arduino-iot-cloud* published on npm, you might need to force require an update.

If you're using a service hosting your node-red instance and you want to be sure that you're using the latest version of _node-red-contrib-arduino-iot-cloud_ published on npm, you might need to force require an update.

You can use either one of these methods:
- Go to [https://flows.nodered.org/add/node](https://flows.nodered.org/add/node) and write `node-red-contrib-arduino-iot-cloud` in the input field
- If you are logged in, you should see a `check for update` on the right side of the [module's page](https://flows.nodered.org/node/@arduino/node-red-contrib-arduino-iot-cloud)

- Go to [https://flows.nodered.org/add/node](https://flows.nodered.org/add/node) and write `node-red-contrib-arduino-iot-cloud` in the input field
- If you are logged in, you should see a `check for update` on the right side of the [module's page](https://flows.nodered.org/node/@arduino/node-red-contrib-arduino-iot-cloud)

## Configuration
1. Obtain Client ID and Client Secret from the [integrations webpage](https://create.arduino.cc/iot/integrations) by clicking on *Create API key*

1. Obtain Client ID and Client Secret from the [integrations webpage](https://create.arduino.cc/iot/integrations) by clicking on _Create API key_
2. Go to Node-RED web page
3. Select one Arduino nodes from the pallete and drag to a flow
4. Double click on the node
* set a new connection
+ select 'Add new arduino-connection...' in the field 'Connection'
+ Click edit (Pencil button)
+ Insert a connection name, Client ID and Client Secret (collected at point 1)
+ Click Add
* Select a thing
* Select a Property
* Set a name
- set a new connection
- select 'Add new arduino-connection...' in the field 'Connection'
- Click edit (Pencil button)
- Insert a connection name, Client ID and Client Secret (collected at point 1)
- Click Add
- Select a thing
- Select a Property
- Set a name
5. Connect Arduino property input node to other nodes to consume data coming from a thing property.
6. Send a payload to the Arduino property output node to change the value of a thing property.

## Nodes

### property (In)

This node injects in the flow the changed value of a specific Arduino IoT Cloud property.

### property (Out)

This node update a specific Arduino IoT Cloud property with the value received in input

### historic

This node injects in the flow a set of values of an Arduino IoT Cloud Property based on the node configuration.
Node parameter:
+ Time Filter: defines time range for historical values

- Time Filter: defines time range for historical values

### periodic

This node injects in the flow the value of an Arduino IoT Cloud Property with a periodicity based on the node configuration.
Node parameter:
+ Poll Every: defines polling time interval (seconds, minutes, hours, days, weeks)

- Poll Every: defines polling time interval (seconds, minutes, hours, days, weeks)

### inject
This node injects in the flow the value of an Arduino IoT Cloud Property after receiving an input event.

This node injects in the flow the value of an Arduino IoT Cloud Property after receiving an input event.
36 changes: 18 additions & 18 deletions arduino-iot-client-mqtt/ArduinoCloudError.js
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
/*
* Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
* This file is part of node-red-contrib-arduino-iot-cloud.
* Copyright (c) 2019
*
* This software is released under:
* The GNU General Public License, which covers the main part of
* node-red-contrib-arduino-iot-cloud
* The terms of this license can be found at:
* https://www.gnu.org/licenses/gpl-3.0.en.html
*
* You can be released from the requirements of the above licenses by purchasing
* a commercial license. Buying such a license is mandatory if you want to modify or
* otherwise use the software for commercial activities involving the Arduino
* software without disclosing the source code of your own applications. To purchase
* a commercial license, send an email to [email protected].
*
*/
* Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
* This file is part of node-red-contrib-arduino-iot-cloud.
* Copyright (c) 2019
*
* This software is released under:
* The GNU General Public License, which covers the main part of
* node-red-contrib-arduino-iot-cloud
* The terms of this license can be found at:
* https://www.gnu.org/licenses/gpl-3.0.en.html
*
* You can be released from the requirements of the above licenses by purchasing
* a commercial license. Buying such a license is mandatory if you want to modify or
* otherwise use the software for commercial activities involving the Arduino
* software without disclosing the source code of your own applications. To purchase
* a commercial license, send an email to [email protected].
*
*/
module.exports = class ArduinoCloudError extends Error {
constructor(code, message) {
super(message);
Expand All @@ -31,4 +31,4 @@ module.exports = class ArduinoCloudError extends Error {

this.code = code;
}
}
};
Loading

0 comments on commit f922030

Please sign in to comment.