README.md

DevDeck - Home Assistant

Home Assistant controls for DevDeck.

Installing

Simply install DevDeck - Home Assistant into the same python environment that you have installed DevDeck.

pip install devdeck-home-assistant

You can then update your DevDeck configuration to use decks and controls from this package.

Controls

• CallServiceControl

  Can be used to call any Home Assistant service

• SwitchToggleControl

  Can be used to toggle the state of a switch entity

• LightToggleControl

  Can be used to toggle the state of a light entity

Configuration

Example configuration:

decks:
  - serial_number: "ABC123"
    name: 'devdeck.decks.single_page_deck_controller.SinglePageDeckController'
    settings:
      controls:
        - name: 'devdeck_home_assistant.light_toggle_control.LightToggleControl'
          key: 0
          settings:
            api_key: 'YOUR_API_KEY_GOES_HERE'
            entity_id: 'light.your_light_entity_id'
            url: 'htts://homeassistant:8123'
        - name: 'devdeck_home_assistant.switch_toggle_control.SwitchToggleControl'
          key: 1
          settings:
            api_key: 'YOUR_API_KEY_GOES_HERE'
            entity_id: 'switch.your_switch_entity_id'
            url: 'htts://homeassistant:8123'
        - name: 'devdeck_home_assistant.call_service_control.CallServiceControl'
          key: 2
          settings:
            api_key: 'YOUR_API_KEY_GOES_HERE'
            url: 'htts://homeassistant:8123'
            service: scene.turn_on
            data:
              entity_id: scene.work_mode
            emoji: ':laptop:'
        - name: 'devdeck_home_assistant.call_service_control.CallServiceControl'
          key: 3
          settings:
            api_key: 'YOUR_API_KEY_GOES_HERE'
            url: 'htts://homeassistant:8123'
            service: media_player.media_play_pause
            data:
              entity_id: media_player.office_sonos
            state_entity: media_player.office_sonos
            state_map:
              playing:
                emoji: ':pause_button:'
              paused:
                emoji: ':play_button:'
              idle:
                emoji: ':watch:'
        - name: 'devdeck_home_assistant.call_service_control.CallServiceControl'
          key: 4
          settings:
            api_key: 'YOUR_API_KEY_GOES_HERE'
            url: 'htts://homeassistant:8123'
            service: script.noop
            state_entity: media_player.office_sonos
            state_map:
              _default:
                entity_image: media_player.office_sonos

Prerequisites

You must have the API enabled by having an api entry in your home assistant configuration:

api:

See the Home Assistant API docs for more details.

You will also need a Long-Lived Access Token which can be generated from the profile page (/profile).