use_case_2

Use Case 2: Add Notification Channel

This code demonstrates how to add a notification channel to a specific asset.

Execute

To run this demo, execute the following:

python use_case_2/add_notification_channel.py <ASSET ID LIST> -nt <NOTIFICATION TYPE> -nc <NOTIFICATION CHANNEL> -u <URL>

For example, to configure the cloud such that the assets 1234 and 4567 are sending a webhook notification (notification channel 3) to https://webhook.site/bcf22b9e-9a30-45c2-890b-a9b948XXXXXX if a new measurement was loaded (notification type 13), you can type:

python use_case_2/add_notification_channel.py 1234 4567 -nt 13 -nc 3 -u https://webhook.site/bcf22b9e-9a30-45c2-890b-a9b948XXXXXX

Result

Sample output - Click to expand!

Task SUCCESS

## Arguments ### Asset ID List Defines to which assets this notification channel should apply.

Notification Type

Defines, what kind of notifications should be set up for the defined assets.

• load measurement alert = 2
• load measurement alarm = 3,
• measurement taken reminder = 5
• asset nameplate data edited = 9
• low battery capacity = 12
• load measurement notification = 13

Notification Channel

Defines the interface where the notification should be sent

• webhooks = 3

URL

The URL is the endpoint that the Smart Sensor cloud would send the notification to, which is typically a web service exposed by your system. If you don't have this web service, you can go to https://webhook.site to set up a temporary endpoint. In this case, your data will be sent to Webhook.site so please pay attention to their privacy policy and use it at your own risk.

1. Go to https://webhook.site
2. Copy Your unique URL
3. Use this URL as an argument
4. See the notifications in the left column of the website

Settings

If you have not configured your credentials in the settings.yaml file in the root folder, the program will ask you to input your username, password, or API key.