konnected-io / noonlight-hass

HomeAssistant integration for Noonlight
42 stars 9 forks source link

Add installation instructions in the readme #9

Open beausmith opened 3 years ago

beausmith commented 3 years ago

Home Assistant has evolved and it seems that this is not an officially supported integration and thus is not listed among the official integrations which can be added easily.

However the fact that a hacs.json file exists lead me to install HACS in order to get this support in home assistant.

I did also use the Manual Alarm Control to complete the integration.

So the process was:

  1. Install Konnected.io integration, attach sensors to the boards, and configure the boards.

  2. Install HACS.

  3. Install noonlight-hass via HACS.

  4. Add a noonlight entry to the configuration.yaml file:

    # Noonlight
    noonlight:
      id: YOUR_ID_HERE
      secret: YOUR_SECRET_HERE
      api_endpoint: https://api.noonlight.com/platform/v1
      token_endpoint: https://noonlight.konnected.io/ha/token
  5. Install integration for the Manual Alarm Control

  6. Add config for the Manual alarm control the the configuration.yaml file:

    alarm_control_panel:
      - platform: manual
  7. Create Automation to call Noonlight if the Manual alarm is triggered:

    konnected-noonlight-automation

    Here is the YAML version automatically created from the UI above:

    alias: Noonlight Alarm
    description: ''
    trigger:
      - platform: state
        entity_id: alarm_control_panel.ha_alarm
        to: triggered
    condition: []
    action:
      - service: homeassistant.turn_on
        target:
          entity_id: switch.noonlight_switch
    mode: single

    At this point you can manually trigger the automation test that the integration between the Manual alarm and Noonlight is working.

  8. Create automations to trigger the manual alarm if various sensors connected to the Konnected.io board change. This step is not detailed here because it will be different based upon what sensors you have.