@isaac-platform/isaac-node-red/README.md

Set of Node-RED nodes to communicate with an ISAAC system

# ISAAC Node-RED Nodes

This package provides a set of Node-RED nodes to communicate with an ISAAC system. Features include:

- Fetching and managing ISAAC data including control panels, events, playables and variables.
- Receiving schedule updates.
- Capturing ISAAC messages received through Heartbeat exchanges.
- Creating Activity Logs entries.

## Installation

1. Open Node-RED's [Palette Manager](https://nodered.org/docs/user-guide/editor/palette/manager).
2. Navigate to the Install tab.
3. Search for `@isaac-platform/isaac-node-red` and click the Install button.

Alternatively, the package can be installed from the command line. See [Installing with npm](https://nodered.org/docs/user-guide/runtime/adding-nodes#installing-with-npm) to learn more.

## Reference

In addition to the nodes' help content available in Node-RED's [Help Sidebar](https://nodered.org/docs/user-guide/editor/sidebar/help), you may also refer to:

- ISAAC's User Manual (_"Node-RED Module"_ section), which goes over the Node-RED integration for ISAAC.
- ISAAC's API documentation (Swagger), which provides information about the underlying endpoints used by the nodes. This is necessary to understand what properties to provide when creating or updating data using JSON payloads.

Visit [ISAAC Platform Homepage](https://isaacplatform.com)

## Changelog

### 3.4.2

#### Variable Node

- Convert variable value to string when using the **Add/replace one** action.

### 3.4.1

#### Variable Node

- Fix "[400] Bad Request: 'value' must be a string" error when updating a variable's value with the **Update value** action.

#### Generic Request Node

- Fix typo in node documentation.

### 3.4.0

#### Playable Node

- Add support for `forceCached` property with corresponding **Available for Instant Play** checkbox in form.
- Convert value of **Duration** field to number.

### 3.3.3

#### Variable Node

- Fix "Invalid JSON data" warnings that appear on the node due to non-string values being provided to code editor form fields. These warnings did not affect the node's functionality.
- Change **Update value** (`updateValue`) action to use a different ISAAC API endpoint for improved performance.
- Rename **Add/update one** to **Add/replace one**. The underlying `upsert` remains unchanged.
- Convert variable value to string when using the **Update value** action.

#### Control Panel Node

- Fix "Invalid JSON data" warning that appears on the node due to the **Payload** field being empty by default. The latter now defaults to `{}` for new node instances. This warning did not affect the node's functionality.

### 3.3.2

#### Schedule Node

- Add a **Commands Only** header in the UI form to indicate which fields apply exclusively to commands (`getUpcomingItems` and `getCurrentPlaying`).
- Change the **Use If-Modified-Since header** label to **Get changed data only** in the UI form.

### 3.3.1

#### Schedule Node

- Document that using `config.useIfModifiedSince` and `config.upcomingCount` together may lead to unexpected results.

### 3.3.0

#### All Nodes

- Use the ISAAC logo for node icons and change node colors.
- Mark required properties in UI forms with asterisks (\*). These properties can be specified either via UI forms or through incoming messages.
- Add notes at the bottom of UI forms explaining that properties can be overridden by incoming messages.
- Add tooltips on UI form labels, indicating which incoming message property will override each UI form input.
- Add links at the bottom of UI forms to easily open the relevant ISAAC Workspace and ISAAC API Documentation pages for each node.
- Indicate optional properties in node documentation.

#### Schedule Node

- Add a **Use If-Modified-Since header** (`useIfModifiedSince`) option to enable automatic usage of the `If-Modified-Since` header when fetching schedules using node commands.

#### Log Entry Node

- Add a **Moderate** option to the Severity dropdown.