Implement a check to return the status of the system

[palazzem]

Overview

At the moment is not possible to retrieve the status of the system, that is important to have a read capability on the system. ElmoClientshould:

• Check the global status if any area is in alerted state
• Check the status for each area, if the alarm is armed or disarmed
• Check the status for each area, if the area is in alerted state
• Check if the alarm is triggered
• List of items in alerted state

[palazzem]

Available APIs

• Armed/Disarmed areas: https://connect.elmospa.com/api/areas | POST | sessionId

  [{'Active': True,
  'ActivePartial': False,
  'Max': False,
  'Activable': True,
  'ActivablePartial': False,
  'InUse': True,
  'Id': 466,
  'Index': 0,
  'Element': 1,
  'CommandId': 0,
  'InProgress': False}, ...]

• Inputs status: https://connect.elmospa.com/api/inputs | POST | sessionId

  [{'Alarm': False,
  'MemoryAlarm': False,
  'Excluded': False,
  'InUse': True,
  'IsVideo': False,
  'Id': 1010,
  'Index': 0,
  'Element': 1,
  'CommandId': 0,
  'InProgress': False}, ...]

• Area in alerted state: can be detected by iterating "Inputs status"

Scraping

Unfortunately APIs don't provide the name of the area or the item in alerted state. To grab the actual name, we can use beautifulsoup4 and do scraping on main pages:

• Area names: https://connect.elmospa.com/vendor/Areas | GET | only cookies
• Entries names: https://connect.elmospa.com/vendor/Inputs | GET | only cookies

Extraction:

from bs4 import BeautifulSoup

page = client._session.get("https://connect.elmospa.com/vendor/Areas")  # or Inputs
tree = BeautifulSoup(page.text, "html.parser")
rows = tree.select('tbody > tr')
areas = [x.getText().split('\n')[1] for x in rows]

# Output: ['Entryway', 'Kitchen', 'Bathroom', 'Something', 'Perimeter']
# Output: ['Door', 'Window']

Usage

status = client.check()
print(status)

# Output:
{
"areas_armed": [{"id": 0, "name": "Entryway"}, ...],
"areas_disarmed": [{"id": 1, "name": "Kitchen"}, ...],
"inputs_alerted": [{"id": 0, "name": "Door"}, ...],
"inputs_wait": [{"id": 1, "name": "Window"}, ...],
}