ziggs/README.md

39 lines
1.6 KiB
Markdown
Raw Normal View History

2022-09-06 23:36:38 +00:00
# Ziggs
2022-09-26 17:11:45 +00:00
![Ziggs Demo](https://tcp.ac/i/wW3Fh.gif)
2022-09-06 23:36:38 +00:00
2022-09-22 03:48:13 +00:00
There are zigbees in my head.
2022-09-06 23:36:38 +00:00
2022-09-22 03:48:13 +00:00
### Huh?
This tool was only planned as a personal tool for myself, consequently the codebase is pretty messy.
2022-09-22 03:48:13 +00:00
With that being said, it should work fairly well to provide a command line interface for Phillips Hue brudges.
2022-09-06 23:36:38 +00:00
2022-09-22 04:00:50 +00:00
### Features and Examples
- **interactive readline shell**
2022-09-22 03:48:13 +00:00
- run `go run ./ shell` || `ziggs shell`
2022-09-22 04:00:50 +00:00
- **manage multiple hue bridges at the same time**
2022-09-22 03:48:13 +00:00
- e.g target specific bridge: `use ECC0FAFFFED55555`
2022-09-22 04:00:50 +00:00
- **control color/saturation/hue/brightness/power per light or per group**
2022-09-22 03:48:13 +00:00
- e.g. group: `set group kayos brightness 55`
- e.g. light: `set light kayos_lamp off`
- **list**, **delete**, and **rename** for the following targets
2022-09-22 04:00:50 +00:00
- lights, groups, scenes, rules, schedules
- **create groups**
- e.g: `create group bedroom 5 3 2 10`
- **specify color by HTML hex colors**
2022-09-22 03:48:13 +00:00
- e.g: `set group kayos color #2eebd3`
2022-09-22 04:00:50 +00:00
- **set light/group colors dynamically based on CPU load (run second time to turn off)**
2022-09-22 03:48:13 +00:00
- mode 1 - average across all cores: `set group kayos cpu`
- mode 2 (group only) cycle through individual lights in group and set based on per-core usage: `set group kayos cpu2`
2022-09-22 04:00:50 +00:00
- **access firewalled bridge via SOCKS proxy**
2022-09-22 03:48:13 +00:00
- to use this, change the config manually (~/.config/ziggs/config.toml)
2022-09-22 04:00:50 +00:00
- **port scan to find offline (no call home) bridges on LAN**
- see gif above for demonstration
2022-09-22 03:48:13 +00:00
- config will automatically save when a bridge connection is established
- **trigger firmware updates for bridge and lights manually**
- e.g: `upgrade`
2022-09-06 23:36:38 +00:00
---