README
¶
RFPlayer-Go
CLI tool and API for RFPlayer, in Go. This CLI tool allows to configure the RFPlayer and to send commands to it via the CLI and see the configured devices via HomeKit.
Installation
go install github.com/julienrbrt/rfplayer-go/cmd/rfplayer@latest
How to use
Help is available via the command line:
rfplayer --help
Record a signal (parrot):
rfplayer record --action ON --id 1 --metadata "zonwering-1-1"
Change the frequency band of the RFPlayer:
rfplayer setfreq --band H --freq 868350
rfplayer setfreq --band L --freq 433420
Troubleshooting
If you need to use sudo to access the serial port, you can add your user to the dialout group:
sudo usermod -aG dialout $USER
Then, log out and log back in for the changes to take effect.
Documentation
¶
Index ¶
- type ParrotDevice
- type RFDeviceAccessory
- type RFPlayer
- func (r *RFPlayer) Close() error
- func (r *RFPlayer) EmitSignal(protocol string, id int, action string) (string, error)
- func (r *RFPlayer) EnableReceiver(protocols ...string) (string, error)
- func (r *RFPlayer) FactoryReset(all bool) error
- func (r *RFPlayer) GetStatus(statusType string, format string) (string, error)
- func (r *RFPlayer) Hello() (string, error)
- func (r *RFPlayer) ParrotRemapping(protocol string, startID int) (string, error)
- func (r *RFPlayer) Ping() error
- func (r *RFPlayer) RecordSignal(id int, action, metadata string) (string, error)
- func (r *RFPlayer) SendCommand(cmd string) (string, error)
- func (r *RFPlayer) SetFormat(format string) (string, error)
- func (r *RFPlayer) SetFrequency(band string, freq int) (string, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ParrotDevice ¶
ParrotDevice represents a Parrot device from the RFPlayer.
func GetParrotDevices ¶
func GetParrotDevices(rf *RFPlayer) ([]ParrotDevice, error)
GetParrotDevices returns a list of Parrot devices from the RFPlayer.
type RFDeviceAccessory ¶
type RFDeviceAccessory struct {
*accessory.A
Switch *accessory.Switch
// contains filtered or unexported fields
}
RFDeviceAccessory represents a HomeKit accessory for an RF device.
func NewRFDeviceAccessory ¶
func NewRFDeviceAccessory(info accessory.Info, rf *RFPlayer, id int, protocol string) (*RFDeviceAccessory, error)
NewRFDeviceAccessory creates a new RFDeviceAccessory instance.
type RFPlayer ¶
type RFPlayer struct {
// contains filtered or unexported fields
}
func NewWithPort ¶
func NewWithPort(port io.ReadWriteCloser) *RFPlayer
NewWithPort creates a new RFPlayer instance with a custom io.ReadWriteCloser.
func (*RFPlayer) EmitSignal ¶
EmitSignal sends a signal using the RFPlayer
func (*RFPlayer) EnableReceiver ¶
EnableReceiver enables specific protocols for receiving
func (*RFPlayer) FactoryReset ¶
FactoryReset performs a factory reset on the RFPlayer
func (*RFPlayer) ParrotRemapping ¶
ParrotRemapping remaps Parrot entries to another protocol
func (*RFPlayer) RecordSignal ¶
RecordSignal puts the RFPlayer in learning mode to record a signal
func (*RFPlayer) SendCommand ¶
SendCommand sends a command to the RFPlayer and returns the response
Source Files
Directories