Skip to content

HomeAssistant integration for Noonlight - add address using V1 API

Notifications You must be signed in to change notification settings

aescolastico/noonlight-hass

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 

Repository files navigation

Noonlight for HomeAssistant

This is the Noonlight integration for HomeAssistant.

This particular version is a fork of the official version on the Konnected.io repository. This adds address information using the v1 API. There is another fork on On3man's Github that already does this and more, but apparently uses the v2 API that may not be appropriate for this usage (see this message in the pull request). So far as I know, On3man's repository works fine, this is just an attempt to make something that may be "more compliant".

Noonlight connects your smart home to local emergency services to help keep you safe in case of a break-in, fire, or medical emergency.

Noonlight service is currently available in the United States.

How it Works

Noonlight connects to emergency 9-1-1 services in all 50 U.S. states. Backed by a UL-compliant alarm monitoring center and staffed 24/7 with live operators in the United States, Noonlight is standing by to send help to your home at a moment's notice.

When integrated with Home Assistant, a Noonlight Alarm switch will appear in your list of entities. When the Noonlight Alarm switch is turned on, this will send an emergency signal to Noonlight. You will be contacted by text and voice at the phone number associated with your Noonlight account. If you confirm the emergency with the Noonlight operator, or if you're unable to respond, Noonlight will dispatch local emergency services to your home using the longitude and latitude coordinates specified in your Home Assistant configuration.

Additionally, a new service will be exposed to Home Assistant: noonlight.create_alarm, which allows you to explicitly specify the type of emergency service required by the alarm: medical, fire, or police. By default, the switch entity assumes "police".

False alarm? No problem. Just tell the Noonlight operator your PIN when you are contacted and the alarm will be canceled. We're glad you're safe!

The Noonlight Switch can be activated by any Home Assistant automation, just like any type of switch! See examples below.

Initial set up

Setup requires a U.S. based mobile phone number.

  1. Ensure that your longitude and latitude coordinates are set accurately so that Noonlight knows where to send help.

  2. Click the link below to set up a Noonlight account and authorize Home Assistant to create alarms on your behalf:

    Connect to Noonlight

  3. Copy and paste the resulting YAML snippet into your configuration.yaml and restart Home Assistant

Configuration

A noonlight section must be present in the configuration.yaml file to enable the Noonlight Alarm entity.

Note: This configuration snippet will be generated for you automatically to copy and paste when you follow the initial setup steps

# Example configuration.yaml entry
noonlight:
  id: NOONLIGHT_ID
  secret: NOONLIGHT_SECRET
  api_endpoint: https://api.noonlight.com/platform/v1
  token_endpoint: https://noonlight.konnected.io/ha/token
  • id: A unique identifier assigned to you when you complete the initial setup steps
  • secret: A secret key associated with your id
  • api_endpoint: The Noonlight API endpoint used when creating an alarm
  • token_endpoint: The OAuth endpoint used to refresh your Noonlight auth token (hosted by Konnected)

To use the address functionality, you need to add some additional items to the above entry. If you don't populate these, the base lat/long-based functionality will still be used.

# Example configuration.yaml entry
noonlight:
  id: NOONLIGHT_ID
  secret: NOONLIGHT_SECRET
  api_endpoint: https://api.noonlight.com/platform/v1
  token_endpoint: https://noonlight.konnected.io/ha/token
  line1: '123 Street Address'
  line2: 'Apt X'
  city: 'Anytown'
  state: 'WA'
  zip: '98100'
  • line1: Street address
  • line2: Apartment, suite, etc. (optional)
  • city: City/town name
  • state: Two-letter state abbreviation
  • zip: Zip code

Automation Examples

Notify Noonlight when an intrusion alarm is triggered

This example is using the Manual Alarm component

automation:
  - alias: 'Activate the Noonlight Alarm when the security system is triggered'
    trigger:
      - platform: state
        entity_id: alarm_control_panel.ha_alarm
        to: 'triggered'
    action:
      - service: homeassistant.turn_on
        entity_id: switch.noonlight_alarm

Notify Noonlight when a smoke detector detects smoke

automation:
  - alias: 'Activate the Noonlight Alarm when smoke is detected'
    trigger:
      - platform: state
        entity_id: binary_sensor.smoke_alarm
        to: 'on'
    action:
      - service: homeassistant.turn_on
        entity_id: switch.noonlight_alarm

Warnings & Disclaimers

**Requires an Internet connection!** Home Assistant must have an active internet connection for this to work!

NO GUARANTEE

This integration is provided as-is without warranties of any kind. Using Noonlight with Home Assistant involves multiple service providers and potential points of failure, including (but not limited to) your internet service provider, 3rd party hosting services such as Amazon Web Services, and the Home Assistant software platform. Please read and understand the Noonlight terms of use, Konnected terms of use and Home Assistant terms of Service, each of which include important limitations of liability and indemnification provisions.

About

HomeAssistant integration for Noonlight - add address using V1 API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%