node-red-contrib-esphome
v0.2.8
Published
Node-RED nodes to ESPhome devices
Downloads
516
Maintainers
Readme
node-red-contrib-esphome
About
!!! Alpha, Alpha, Alpha release
!!! Need help writing documentation
Node-RED nodes to ESPhome devices
Changelog
0.2.7
- fix status issues/36
0.2.5
0.2.3
- support Text
0.2.1
- support Status in node
Installation
$ npm i node-red-contrib-esphome
Inputs
Inputs are sent to the node as JSON payloads. The list below provides a list of keys and values (and their expected value type) that may be sent to the "esphome out" nodes. It is helpful to watch the "esphome in" messages to learn which type and range of commands are expected by your device.
Some example message payloads are:
// to set a light on:
msg.payload = {'state': true}
// set a door lock to unlock:
msg.payload = {'command':0}
// to toggle a light to 42% brightness:
msg.payload = {'brightness': 42}
// to press a button:
msg.payload = true
Button
Button inputs may be triggered with any payload in the input message. Simply send a timestamp, true
, or other payload to the button node. Button type nodes provide no messages into Node-RED.
Climate
mode
- optional. 0 - OFF, 1 - AUTO, 2 - COOL, 3 - HEAT, 4 - FAN_ONLY, 5 - DRY. SeesupportedModesList
attr in configtargetTemperature
- optional. floattargetTemperatureLow
- optional. floattargetTemperatureHigh
- optional. floatlegacyAway
- optional. Boolean. Deprecated: usepreset
with AWAYfanMode
- optional. 0 - ON, 1 - OFF, 2 - AUTO, 3 - LOW, 4 - MEDIUM, 5 - HIGH, 6 - MIDDLE, 7 - FOCUS, 8 - DIFFUSE, 9 - QUIET. SeesupportedFanModesList
attr in configswingMode
- optional. 0 - OFF, 1 - BOTH, 2 - VERTICAL, 3 - HORIZONTAL. SeesupportedSwingModesList
attr in configcustomFanMode
- optional. string. SeesupportedCustomFanModesList
attr in configpreset
- optional. 0 - NONE, 1 - HOME, 2 - AWAY, 3 - BOOST, 4 - COMFORT, 5 - ECO, 6 - SLEEP, 7 - ACTIVITY. SeesupportedPresetsList
attr in configcustomPreset
- optional. string. SeesupportedCustomPresetsList
attr in config
Cover
legacyCommand
- optional. 0 - OPEN, 1 - CLOSE, 2 - STOP. Deprecated: useposition
position
- optional. float. 0.0 - CLOSED, 1.0 - OPEN. SeesupportsPosition
attr in configtilt
- optional. float. 0.0 - CLOSED, 1.0 - OPEN. SeesupportsTilt
attr in configstop
- optional. boolean
Fan
state
- optional. booleanspeed
- optional. 0 - LOW, 1 - MEDIUM, 2 - HIGHoscillating
- optional. booleandirection
- optional. 0 - FORWARD, 1 - REVERSEspeedLevel
- optional. integer. SeesupportedSpeedLevels
attr in config
Light
state
- optional. booleanbrightness
- optional. floatred
- optional. integer 0-255green
- optional. integer 0-255blue
- optional. integer 0-255colorMode
- optional. integer. SeesupportedColorModesList
attr in configcolorBrightness
- optional. floatwhite
- optional. integer 0-255colorTemperature
- optional. integercoldWhite
- optional. floatwarmWhite
- optional. floatflashLength
- optional. integereffect
- optional. string. effect from effects array in config list
Lock
command
- REQUIRED. 0 - UNLOCK, 1 - LOCK, 2 - OPENcode
- optional. string. SeerequiresCode
attr in config
MediaPlayer
command
- REQUIRED. 0 - MEDIA_PLAYER_COMMAND_PLAY, 1 - MEDIA_PLAYER_COMMAND_PAUSE, 2 - MEDIA_PLAYER_COMMAND_STOP, 3 - MEDIA_PLAYER_COMMAND_MUTE, 4 - MEDIA_PLAYER_COMMAND_UNMUTEvolume
- optional. floatmediaUrl
- optional. string
Number
state
- REQUIRED. float. SeeminValue
,maxValue
, andstep
attrs in config
Select
state
- REQUIRED. string. SeeoptionsList
attr in config
Siren
state
- REQUIRED. booleantone
- optional. string. SeetonesList
attr in configduration
- optional. integer. SeesupportsDuration
attr in configvolume
- optional. integer. SeesupportsVolume
attr in config
Switch
state
- REQUIRED. boolean
Text
state
- REQUIRED. string. SeeminLength
,maxLength
attrs in config