API & Integrations

MQTT

Publishes all available information under topic: yarrboard/frothfet/pwm/{channel-key}/*

Field	Type	Description
state	string	ON / OFF / TRIPPED / BLOWN / BYPASSED / OVERHEAT
source	string	What last changed the channel state (e.g. manual, mqtt, serial, timer)
duty	float	PWM duty cycle from 0.0 to 1.0 - Only present if the channel is dimmable.
voltage	float	Channel voltage in volts
current	float	Channel current in amps
wattage	float	Channel power in watts
temperature	float	Channel temperature in °C
aH	float	Accumulated amp-hours since last reset
wH	float	Accumulated watt-hours since last reset

Home Assistant

To use FrothFET with Home Assistant, follow these steps:

• Install the Mosquitto Broker (MQTT server) app in Home Assistant.
• Enable MQTT discovery in Home Assistant (Settings → Devices & Services → MQTT)
• In FrothFET, enable MQTT and the Home Assistant features
• In Home Assistant, it should show the discovered FrothFET device
• Each channel will be listed as an appropriate entity that can be controlled by Home Assistant.
• FrothFET also provides voltage, current, and wattage for each channel as entities.

Raw API

The protocol for communicating with Yarrboard is entirely based on JSON messages. Each request to the server should be a single JSON object, and the server will respond with a JSON object.

The protocol works over the following transport layers:

• HTTP API
• Websockets
• USB Serial
• MQTT

Here are some example commands you could send:

{"cmd":"ping"}
{"cmd":"get_config","value":true,"user":"admin","pass":"admin"}
{"cmd":"set_channel","key":"galley-light","state":true,"user":"admin","pass":"admin"}
{"cmd":"login","user":"admin","pass":"admin"}
{"cmd":"set_channel","key":"galley-light","state":true}
{"cmd":"set_channel","key":"galley-light","duty":0.99}
{"cmd":"set_channel","key":"galley-light","duty":0.5}
{"cmd":"set_channel","key":"galley-light","duty":0.1}
{"cmd":"set_channel","key":"galley-light","state":false}

For detailed information on the FrothFET PWM protocol, see src/controllers/PWMChannelController.cpp

Visit the YarrboardFramework documentation page for more details on the underlying protocol.

SignalK

All the same data as MQTT, but in SignalK delta format. The specific SignalK path is coming soon.