Skip to content

Control Interfaces

Jump to bottom
helgeerbe edited this page Jun 3, 2022 · 4 revisions

MQTT topics and messages

There are two styles of topic depending on how communication is being used by homeassistant. In the list below I will give the topic followed by possible messages. First switch or button style, then value messages

  1. on the basis that you have defined device_id: 'picframe' in configuration.yaml
  2. display on/off: homeassistant/switch/picframe_display/set, ON,OFF
  3. paused on/off: homeassistant/switch/picframe_paused/set, ON,OFF
  4. shuffle on/off: homeassistant/switch/picframe_shuffle/set, ON,OFF
  5. back: homeassistant/button/picframe_back/set, ON
  6. next: homeassistant/button/picframe_next/set, ON
  7. name text on/off: homeassistant/switch/picframe_name_toggle/set, ON,OFF
  8. date text on/off: homeassistant/switch/picframe_date_toggle/set, ON,OFF
  9. location text on/off: homeassistant/switch/picframe_location_toggle/set, ON,OFF
  10. directory text on/off: homeassistant/switch/picframe_directory_toggle/set, ON,OFF
  11. title text on/off: homeassistant/switch/picframe_title_toggle/set, ON,OFF
  12. caption text on/off: homeassistant/switch/picframe_caption_toggle/set, ON,OFF
  13. all text off: homeassistant/switch/picframe_text_off/set, ON # yes that is confusing!
  14. text refresh: homeassistant/switch/picframe_text_refresh/set, ON
  15. delete: homeassistant/button/picframe_delete/set, ON
  16. clock on/off: homeassistant/switch/picframe_clock/set, ON,OFF

values:

  1. directory: picframe/directory, string matching directory name
  2. date_from: picframe/date_from, string YYYY/MM/DD or number representing unix timestamp or zero length string to remove constraint
  3. date_to: picframe/date_to, string YYYY/MM/DD or number as above
  4. fade_time: picframe/fade_time, number
  5. time_delay: picframe/time_delay, number
  6. brightness: picframe/brightness, float 0.0 to 1.0
  7. location_filter: picframe/location_filter, string matching any part of geolocation description
  8. tags_filter: picframe/tags_filter, string matching tags
  9. stop: picframe/stop, message not used - just stops
  10. matting_images: picframe/matting_images, float 0.0 to 1.0, 0 if matting is activated (true) and 1 if it is deactivated (false). Any value in between is used as value for mat_image_to

The pi3d PictureFrame project Wiki | Slack

Clone this wiki locally