node-red-contrib-freya-nodes/README.md

Custom nodes for Freya Vivarium Control System

![Freya Banner](https://raw.githubusercontent.com/Freya-Vivariums/.github/refs/heads/main/brand/Freya_banner.png)

<img src="https://nodered.org/about/resources/media/node-red-icon.png" align="right" width="10%"/>

**[Node-RED](https://nodered.org/)** is a visual programming tool that lets you wire together hardware, APIs, and online services by connecting blocks in a flow-based editor. The **Freya Node-RED nodes** lorem ipsum...

<br clear="right"/>

[![Node-RED](https://img.shields.io/badge/Node--RED-Freya-%23A2CA6F?logo=nodered)](https://flows.nodered.org/node/node-red-contrib-freya-nodes)

## Installation
#### Node-RED flow editor
Navigate to `Settings > Manage Palette`, then in the `Install` tab, search for `node-red-contrib-freya-nodes` and click the `Install` button.

#### Manually using NPM
On your device, navigate to the `nodered` folder (on a Freya system, it's at `/opt/Freya/`), and run
```
npm install node-red-contrib-freya-nodes
```

## License & Collaboration
**Copyright© 2025 Sanne 'SpuQ' Santens**. The Freya NodeRED nodes project is licensed under the **[MIT License](LICENSE.txt)**. The [Rules & Guidelines](https://github.com/Freya-Vivariums/.github/blob/main/brand/Freya_Trademark_Rules_and_Guidelines.md) apply to the usage of the Freya Vivariums™ brand.

### Collaboration

If you'd like to contribute to this project, please follow these guidelines:
1. Fork the repository and create your branch from `main`.
2. Make your changes and ensure they adhere to the project's coding style and conventions.
3. Test your changes thoroughly.
4. Ensure your commits are descriptive and well-documented.
5. Open a pull request, describing the changes you've made and the problem or feature they address.