Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jhrcook/homebridge-controller
A program to execute custom Homebridge controlling programs.
https://github.com/jhrcook/homebridge-controller
homebridge raspberrypi rust
Last synced: 4 months ago
JSON representation
A program to execute custom Homebridge controlling programs.
- Host: GitHub
- URL: https://github.com/jhrcook/homebridge-controller
- Owner: jhrcook
- Created: 2024-08-18T12:22:50.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-27T21:55:03.000Z (5 months ago)
- Last Synced: 2024-09-29T00:42:38.693Z (4 months ago)
- Topics: homebridge, raspberrypi, rust
- Language: Rust
- Homepage:
- Size: 51.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Personal Homebridge Controller
A program to execute custom Homebridge controlling programs.
## Usage
### Locally
For development:
```bash
. ./.secrets
RUST_LOG="debug" cargo run -- config.yaml
```
### Deploy on Raspberry Pi
Download the ['compose.yaml'](./compose.yaml) and ['Dockerfile'](./Dockerfile) and run the container in the background:
```bash
# Docker files:
wget https://github.com/jhrcook/homebridge-controller/raw/main/Dockerfile
wget https://github.com/jhrcook/homebridge-controller/raw/main/compose.yaml
#> Set the secrets in the "compose.yaml" file.
# Configuration files:
wget https://github.com/jhrcook/homebridge-controller/raw/main/config.json
wget https://github.com/jhrcook/homebridge-controller/raw/main/log4rs.yaml
# Build docker
docker compose up -d
```
## Programs
Global configuration:
- `timezome`: number of hours after GMT
- `ip_addess`: Homebridge IP address
### Morning Light
Turn the light on gradually in the morning.
Configuration:
- `start`: time to start the sequence
- `duration`: duration of fading-in brightness process
- `final_brightness`: maximum brightness
- `start_hue`: starting color hue
- `final_hue`: final color hue
- `active`: whether or not this process is active
### Turning off morning light
Turn the light off later in the morning.
Notes
- Make sure to only perform this once per day.
- Can instead of a specific time set to go off a certain number of minutes after sunrise.
Configuration:
- `off_time`: time to turn the lights off in the morning
- `duration`: duration of the dimming process
- `active`: whether or not this process is active
### Turning on light in the evening
Turn the light on in the evening.
Notes
- make sure to stop the process if the light is turned off during execution
Configuration
- `hours_before_sunset_start`: number of hours before official sunset to start the sequence
- `start_brightness`: starting brightness
- `max_brightness`: maximum brightness
- `final_brightness`: final brightness
- `hours_after_sunset_end`: number of hours after sunset to finish
- `active`: whether or not this process is active