lmnotify 0.0.6

Creating a Custom Application

The following steps are required to register the lmnotify python module as new LaMetric application at their webpage:

1. Sign Up and login to the developer webpage https://developer.lametric.com

2. Click the Create button in the upper right corner, then select Notification App and click Create again.

3. Enter an app name, a description and a redirect URL

4. Finally, click Save to create the application.

For the newly created app you will obtain credentials i.e. the client id and a client secret. Both are required in the following to to setup the python module.

Background

Although, the lmnotify python module must be registered with the LaMetric cloud, on the long run, there is only a very limited interaction with the cloud necessary. The main functions of the cloud-related RESTful API deal with user information stored at the cloud as well as the registered LaMetric devices. Particularly, the latter is of great paramount since the list of devices contains an API key for each device that can be used to communicate with the device in the local network without connecting to the cloud.

For that reason, the default configuration of the module will receive all LaMetric devices from the cloud on the first call of get_devices and store them in the ~/.lmdevices file. All further calls of get_devices will simply read this file and return the devices without any interaction with the LaMetric cloud.

Configuration of the Module

There are three different ways to provide the LaMetric API credentials to the module: by constructor, by environment variables or by config file.

1. By constructor: Just provide the client_id and client_secret in the constructor of the LaMetricManager class, e.g.:

CLIENT_ID = "<my_client_id>"
CLIENT_SECRET = "<my_client_secret>"

lmn = LaMetricManager(client_id=CLIENT_ID, client_secret=CLIENT_SECRET)

2. By environment variables: Just set the LAMETRIC_CLIENT_ID and the LAMETRIC_CLIENT_SECRET environment variable, e.g. in bash:

export LAMETRIC_CLIENT_ID="<my_client_id>"
export LAMETRIC_CLIENT_SECRET="<my_client_secret>"

When not providing the client_id and client_secret in the constructor, the environment variables will be used instead.

3. By config file: The default config file is set to ~/.lmconfig. When initializing the LaMetricManager class without parameters the config file will be loaded, if it is already existing. Otherwise you can set the auto_create_config parameter in the constructor to True, to create an empty configuration file. Simply fill your credentials in the config file:

[lametric]
client_id = <put the client id here>
client_secret = <put the client secret here>

On the next start, the config file will be read automatically, when neither client_id and client_secret are set in the constructor nor the LAMETRIC_CLIENT_ID and the LAMETRIC_CLIENT_SECRET environment variables are set.

As stated above in the background section, after the devices have been obtained from the LaMetric cloud once, all further interaction can be done locally without any interaction with the LaMetric cloud.