README
¶
rpi-radio-alarm-go-library
Wrapper library to communicate with the rpi-radio-alarm-go
Installation
- get the package with
go get - ensure
./rpi_data.yamlis available (if using the helper interacting with storage)settings: port: 8000 run_api: true run_telegram_bot: true run_discord_bot: false alarms: - name: Test hour: 7 minute: 0 days: - 0 - 1 active: false ... radio: running: false pid: -1
License
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api implements a wrapper around the rest api
|
Package api implements a wrapper around the rest api |
|
Package constants contains some constant values
|
Package constants contains some constant values |
|
Package logging contains utils to get a logger with e standardized formatting
|
Package logging contains utils to get a logger with e standardized formatting |
|
Package storage implements a wrapper using the yaml file as "backend"
|
Package storage implements a wrapper using the yaml file as "backend" |
|
Package types contains all the relevant structs/types for the library
|
Package types contains all the relevant structs/types for the library |
Click to show internal directories.
Click to hide internal directories.