Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mhawkshaw/homebridge-enviroindoor
Homebridge Accessory for the Pimoroni Enviro Indoor device
https://github.com/mhawkshaw/homebridge-enviroindoor
homebridge homebridge-plugin
Last synced: 4 months ago
JSON representation
Homebridge Accessory for the Pimoroni Enviro Indoor device
- Host: GitHub
- URL: https://github.com/mhawkshaw/homebridge-enviroindoor
- Owner: mhawkshaw
- License: apache-2.0
- Created: 2023-02-12T21:54:10.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-31T21:46:49.000Z (5 months ago)
- Last Synced: 2024-09-26T20:46:40.504Z (4 months ago)
- Topics: homebridge, homebridge-plugin
- Language: TypeScript
- Homepage:
- Size: 463 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pimoroni Enviro Indoor Homebridge Plug-in
This Homebridge plug-in allows you to make the data available from the [Pimoroni Enviro Indoor](https://learn.pimoroni.com/article/getting-started-with-enviro) device.
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
## Setup MQTT broker
This Homebridge plug-in reads the data from an MQTT broker providing the JSON information, for example:
* {"readings": {"pressure": 1007.95, "temperature": 28.31, "voltage": 4.979, "color_temperature": 0, "gas_resistance": 20605, "aqi": 11.4, "humidity": 37.7, "luminance": 0}, "nickname": "my-air-quality", "model": "indoor", "uid": "xxxxxxxxxxxxxx", "timestamp": "2022-09-20T19:45:02Z"}
You can view the entries on your computer using an MQTT viewer, for example [MQTT Explorer](http://mqtt-explorer.com/)
You need to install an [MQTT broker](http://mosquitto.org/) on your machine, this can be any machine in your network, including the machine running Homebridge. Here are some instructions for popular distributions:
### Raspberry Pi / Ubuntu
In short, you just need to do the following:
sudo apt-get update
sudo apt-get install -y mosquitto mosquitto-clients
sudo systemctl enable mosquitto.service
### macOS
Use [Homebrew](https://brew.sh/)
brew install mosquitto
### Windows
Go to the (Mosquitto Download Page)[https://mosquitto.org/download/] and choose the right installer for your system.
### Enable authentication
A quick search online will provide you with information on how to secure your installation. To help you, I've found the following links for the
[Raspberry Pi](https://randomnerdtutorials.com/how-to-install-mosquitto-broker-on-raspberry-pi/) and [Ubuntu](https://www.vultr.com/docs/install-mosquitto-mqtt-broker-on-ubuntu-20-04-server/)
## Plug-in Installation
Follow the [homebridge installation instructions](https://www.npmjs.com/package/homebridge) if you haven't already.
Install this plugin globally:
npm install -g homebridge-enviroindoor
Add platform to `config.json`, for configuration see below.
## Plug-in Configuration
The plug-in needs to know where to find the MQTT broker providing the JSON data (e.g. mqtt://127.0.0.1:1883) along with the serial number of the device to uniquely identify it (you can also use your Raspberry Pi Pico identifier).
```json
{
"platforms": [
{
"platform": "EnviroIndoorAirQuality",
"name": "EnviroIndoor",
"mqttbroker": "mqtt://127.0.0.1:1883",
"username": "",
"password": "",
"devices": [
{
"displayName": "My Enviro Indoor Sensor",
"serial": "1234567890",
"topic": "enviro/my-air-quality"
}
]
}
]
}
```
The following settings are optional:
- `username`: the MQTT broker username
- `password`: the MQTT broker password
If you have multiple Enviro Indoor devices, then you can list them all in the config giving each one a unique name, MQTT topic and serial number.