@palasde/node-red-myatmosphere 1.0.0

A Node-Red node for subscribing to MyAtmosphere device latest measurements

npm install @palasde/node-red-myatmosphere

@palasde/node-red-myatmosphere - Node-Red MyAtmosphere Node

Overview

This project provides a Node-Red node @palasde/node-red-myatmosphere for subscribing to the latest measurements from devices connected to MyAtmosphere air quality monitoring system. It allows users to easily integrate air quality and environmental data into their Node-Red workflows.

Installation

To install the Node-Red node, run the following command in your Node-Red user directory (typically ~/.node-red):

npm install @palasde/node-red-myatmosphere

Usage

Once installed, you can find the MyAtmosphere nodes in the Node-Red palette. The following nodes are available:

• MyATMO Measurements: This node processes and outputs the latest measurements from the devices.

• Connection: This configuration node handles the connection to the MyAtmosphere API and available from the other MyAtmosphere nodes. Usually set per AQ Network.

Configuration

To configure the nodes, you will need to provide the connection details for your MyAtmosphere device:

• API Key: Private or public API key set as part of connection config.
• Serial Numbers: Comma-separated device serial numbers.
• Measurement Types: Comma-separated measurement types (e.g., pm2_5,pm10). When not set, all supported by the device types are included. The exact names of the measurement types can be found in the MyAtmosphere API docs and related section of the API explorer.

Output

MyATMO Measurements node emits the most recent measurement on initial connection and on every real-time update. Message content:

• payload: The exact data contract for the measurement can be found in the MyAtmosphere API docs and related section of the API explorer.
• device: Device serial number.
• dataSet: The constant name of the "Measurements" data set.

Example Flow

Here is an example of how to use the MyAtmosphere nodes in a Node-Red flow:

1. Drag the MyATMO Measurements node onto your workspace and configure it with your connection and device details.
2. Use the output from the MyATMO Measurements node to trigger other nodes in your flow, such as saving the data or sending alerts.

License

This project is licensed under the MIT License. See the LICENSE file in GitHub repository for more details.