0.1.0

Release

This is a first release for elmo-alerting library, which includes the following capabilities:

• Retrieving access tokens to make API calls
• Obtaining/releasing the system Lock() to have exclusive control of the system
• Arm/disarm all the alarms registered in the system

The following example shows how to arm or disarm an Elmo system:

from elmo.api.client import ElmoClient

# Initialize the client with an API endpoint and a vendor and
# authenticate your connection to retrieve the access token
client = ElmoClient("https://example.com", "vendor")
client.auth("username", "password")

# To arm/disarm the system you must gain the exclusive Lock()
with client.lock("secret-code") as c:
    c.arm()     # Arms all alarms
    c.disarm()  # Disarms all alarms

This version should be considered an early version, even though it can be considered stable in terms of functionalities. That said, the API is considered 0.x.y, meaning it can change in the near future. Migration guides will be provided if breaking changes are introduced.