0.4.0 • Published 1 year ago
tasmota-commands-mqtt v0.4.0
Tasmota Commands Mqtt
Overview
Control Tasmota devices with the mqtt protocol.
Install
npm install tasmota-commands-mqtt
or yarn add tasmota-commands-mqtt
Example
const commands = new TasmotaCommandsMqtt({
host: 'tcp://127.0.0.1',
port: 1883,
topic: 'tasmota_living_room',
topicFormat: '%prefix%/%topic%/<command>',
username: 'user',
password: 'password',
});
// Power up the device
await commands.sendCommand('Control', 'Power0', 'on');
// Change light color to red
await commands.sendCommand('Light', 'Color', '255,0,0');
// Get current wifi light color
const color = await commands.sendCommand('Light', 'Color');
// Get current device state
const state = await commands.sendCommand('Management', 'State');
// Send any command with "Custom"
await commands.sendCommand('Custom', 'Sleep', 50);
Parameters
Parameter | Required | Accepted values | Description |
---|---|---|---|
host | yes | brokerUrl with protocol | only tcp:// is currently supported, e.g. tcp://127.0.0.1 |
topic | yes | string | Topic from Tasmota MQTT parameters |
topicFormat | yes | topic format string which includes %prefix% , %prefix% and <command> | Full Topic from Tasmota MQTT parameters with added <command> , usually to end of string e.g. %prefix%/%topic%/<command> |
port | no | number | Broker port e.g. 1883 |
username | no | username | Broker username, if any |
password | no | password | Broker password, if any |
connectOnInit | no | boolean | Defaults to true . Create connection to broker on init. |
and all tasmota-commands-core
parameters are supported.
Setup Development Environment
Install Development Dependencies
Navigate to the project folder and install dependencies with yarn
yarn install
Roadmap
Contribution
License
MIT