https://github.com/edeckers/huemon
Zabbix template with LLD support for Philips Hue network
https://github.com/edeckers/huemon
discovery history home-assistant homeassistant hue hue-api hue-bridge hue-lights lld metrics monitoring philips-hue python zabbix zabbix-templates zigbee
Last synced: 8 months ago
JSON representation
Zabbix template with LLD support for Philips Hue network
- Host: GitHub
- URL: https://github.com/edeckers/huemon
- Owner: edeckers
- License: mpl-2.0
- Created: 2022-02-25T00:06:56.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-10-08T12:21:55.000Z (over 2 years ago)
- Last Synced: 2024-10-01T05:07:39.772Z (over 1 year ago)
- Topics: discovery, history, home-assistant, homeassistant, hue, hue-api, hue-bridge, hue-lights, lld, metrics, monitoring, philips-hue, python, zabbix, zabbix-templates, zigbee
- Language: Python
- Homepage: https://branie.it/blog/huemon-connect-philips-hue-to-zabbix-stats-alarms-and-triggers
- Size: 591 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Huemon
[](https://opensource.org/licenses/MPL-2.0)
[](https://github.com/edeckers/huemon/actions/workflows/test.yml)
[](https://pypi.org/project/huemon)
[](https://github.com/PyCQA/bandit)
Zabbix monitoring with low-level discovery for Philips Hue networks.
## Requirements
- Zabbix server 5.0+
- Zabbix agent 5.0+
- Python 3.9+ on Zabbix agent machine
## Installation
```bash
pip3 install huemon
```
## Configuration
1. Copy `config.example.yml` from `src/huemon` to `/path/to/config.yml`
2. Make necessary changes
3. Provide the path through environment variable `HUEMON_CONFIG_PATH`
### Plugins
Create a command or discovery plugin by implementing [HueCommand](src/huemon/commands/hue_command_interface.py) or [Discovery](src/huemon/discoveries/discovery_interface.py) respectively and copy the file to the configured path in `plugins.commands.path` or `plugins.discoveries.path` of the configuration file.
### Zabbix agent configuration
```
# file:/path/to/zabbix/agent/conf.d/hue.conf
UserParameter=hue.discovery[*],HUEMON_CONFIG_PATH=/path/to/config.yml python3 -m huemon discover $1
UserParameter=hue.value[*],HUEMON_CONFIG_PATH=/path/to/config.yml python3 -m huemon $1 $2 $3
```
Or Docker
```
# file:/path/to/zabbix/agent/conf.d/hue.conf
UserParameter=hue.discovery[*],docker-compose run huemon discover $1
UserParameter=hue.value[*],docker-compose run huemon $1 $2 $3
```
Or _agent mode_
```
# file:/path/to/zabbix/agent/conf.d/hue.conf
UserParameter=hue.discovery[*],curl http://127.0.0.1:8000/discover?q=$1
UserParameter=hue.value[*],curl http://127.0.0.1:8000/$1?q=$2\&q=$3
```
### Configure Systemd service
An installer that configures Huemon as a Systemd service is included in this repository. It uses `/etc/huemon/config.yml` as the configuration path.
```bash
assets/service-installer.sh install
```
## Usage
### Shell
```bash
HUEMON_CONFIG_PATH=/path/to/config.yml python3 -m huemon discover lights
```
Or _agent mode_
```bash
HUEMON_CONFIG_PATH=/path/to/config.yml python3 -m huemon agent start
```
### Docker
Provide a configuration path for the `huemon-config` volume in `docker-compose.yml` before running the commands below.
```bash
docker-compose run huemon discover lights
```
Or _agent mode_
```bash
docker-compose up -d
```
## Screenshots
### Dashboards
### Discoveries
### Template
## Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## Code of Conduct
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
## License
MPL-2.0