Documentation
¶
Overview ¶
rfoutlet provides outlet control via cli and web interface for Raspberry PI 2/3.
The transmitter and receiver logic has been ported from the great https://github.com/sui77/rc-switch C++ project to golang.
rfoutlet comes with ready to use commands for transmitting and receiving remote control codes as well as a command for serving a web interface (see cmd/ directory). The pkg/ directory exposes the gpio package which contains the receiver and transmitter code.
Directories
¶
Path | Synopsis |
---|---|
internal
|
|
command
Package command provides the interfaces for commands that can be pushed into a command queue for the controller to consume.
|
Package command provides the interfaces for commands that can be pushed into a command queue for the controller to consume. |
config
Package config provides the config file schema and utilities to load the config into concrete outlet and outlet group types.
|
Package config provides the config file schema and utilities to load the config into concrete outlet and outlet group types. |
controller
Package controller provides a controller that handles all outlet commands sequentially.
|
Package controller provides a controller that handles all outlet commands sequentially. |
controller/commands
Package commands contains the commands can be handled by the controller.
|
Package commands contains the commands can be handled by the controller. |
outlet
Package outlet provides types for the outlet and outlet group as well as tools to interact with them and to manage their state.
|
Package outlet provides types for the outlet and outlet group as well as tools to interact with them and to manage their state. |
schedule
Package schedule provides types to define time switch schedule intervals for outlets.
|
Package schedule provides types to define time switch schedule intervals for outlets. |
statedrift
Package statedrift provides a detector for listening to rf codes sent out by anything else than rfoutlet (e.g.
|
Package statedrift provides a detector for listening to rf codes sent out by anything else than rfoutlet (e.g. |
timeswitch
Package timeswitch implements the time switch logic for outlets.
|
Package timeswitch implements the time switch logic for outlets. |
websocket
Package websocket provides the http handler, client and hub for managing the websocket connections of clients using rfoutlet.
|
Package websocket provides the http handler, client and hub for managing the websocket connections of clients using rfoutlet. |
pkg
|
|
gpio
Package gpio provides receiver and transmitter functionality for reading remote control codes and sending them out to control remote controlled outlets.
|
Package gpio provides receiver and transmitter functionality for reading remote control codes and sending them out to control remote controlled outlets. |
Click to show internal directories.
Click to hide internal directories.