How to use Notifications

This guide will show you how to set up email messages in Studio using the Notifications feature. Through notifications, customized emails can be sent about specific sensor events, for example to:

  • Know when a Cloud Connector or a sensor is offline
  • Send an alert when a freezer is too hot
  • Alert security when a window opens
  • Notify a maintenance team if there is a water leakage
  • Be aware when someone presses a service button

What you need

  • Access to Studio
  • A user account with Project developer or Project administrator permissions

Steps

  1. In Studio, select the Notifications tab
  2. Select Create a new notification
  3. Choose a suitable name
  4. Select Trigger
  5. Select Schedule (Optional) 
  6. Select Add devices
  7. Select Add recipients
  8. Click Save Notification in the right-hand corner

Select trigger

Select the event that will trigger the notification.

SettingTrigger.png

Trigger Description Devices 
Temperature Triggered when the temperature is above, belowoutside, or within the defined range.

Temperature, EN12830/330s, Humidity, Industrial Temperature sensor, Temperature sensor (Gen 2), Temperature sensor (3rd Gen), CO2 Sensor

Proximity Status When the sensor is covered within 5mm, it is triggered if set to True

Triggered when the sensor stops being covered if set to False
Proximity sensor (Counting Proximity sensor is not supported)
Proximity Count Notifications will be sent when a sensor reaches the set count of open events. The counter resets when the notification has been sent. Proximity sensor

Touched

Notifications will be sent when a sensor is touched All small sensors

Touch Count

Notifications will be sent when a sensor reaches the set count of touches. The counter resets when the notification has been sent. Touch Sensor, Tactile Touch Sensor

Humidity

Triggered when the humidity is above, belowoutside, or within the defined range. Humidity, CO2 Sensor

Water Detected

It is triggered when the sensor is covered with water if set to True

Triggered when the sensor stops being covered with water if set to False
Water Detector

Motion

It is triggered when the sensor detects motion if the state is set to Motion detected

It is triggered when the sensor does not detect motion if the state is set to No motion detected
Motion sensor
CO2 Triggered when the CO2 level is above, belowoutside, or within the defined PPM range. CO2 sensor

Desk Occupancy

It is triggered when the sensor detects occupancy if the state is set to Occupied.

It is triggered when the sensor does not detect occupancy if the state is set to Not occupied.
Desk Occupancy sensor
Offline Monitoring (Beta)

Triggered when a Cloud Connector or a sensor is offline.

For Cloud Connectors: Notifications are triggered when a Cloud Connector has been offline for an extended period of time (5-15 minutes) and is unable to forward sensor events.

For sensors: Notifications are triggered when a sensor loses connection to its Cloud Connectors (eg. due to a depleted battery or going out of range). However, if the Cloud Connector itself goes offline, you won't receive individual sensor notifications.

All sensors and Cloud Connectors

Adding a trigger delay

Notifications can trigger immediately, or after a delay, e.g., the temperature remains above 40°C for 1 hour and 30 minutes, or a door remains open for more than an hour. The maximum delay is 72 hours. 

Updating a notification while a sensor is in the triggering state

If you update the trigger, trigger delay, or schedule while a device in the Notification is triggering*, that state will be ignored, and no e-mail will be sent. 

Example: 

    1. Your Notification is set to send an e-mail whenever a temperature sensor has sent temperature events above 4°C for 1 hour
    2. You decide to update this Notification to get notified when all temperature sensor events have been above 4°C for 2 hours
    3. At the time you update the Notification, one of your sensors has already sent temperature events above 4°C for 30 minutes; and is thus, in the triggering state 
    4. To avoid false alerts, the fact that this sensor is currently triggering will be ignored, and no e-mail will go out. 
    5. The temperature sensor goes below 4°C
    6. The temperature sensor is above 4°C for 2 hours
    7. The trigger is set to true for two hours, and an email notification is sent.  

* Triggering means that the trigger for a device is set to true. You can see the trigger status in the list of devices. 

Schedule

Optionally, you can set a schedule for when the triggers can happen by selecting the desired days and timeslots in the drop-down menus. Notifications triggered outside the set timeslots are not delivered.

Set the schedule to apply for local time or UTC by toggling the option in the right-hand corner.

Schedule.png

Add devices

Add all devices that the notification shall apply to by selecting Add Devices. You will then get a list view of all your devices, similar to the Sensors & Cloud Connectors overview. Add the devices by choosing the (+) to the left of the sensor name.

Add recipients

Currently, sending an email is the only action available. Fill out the recipients, the subject, and the body text to include in the email. 

AddingEmail.png

Variables

You can add variables to the notification text to include relevant information for the device. Supported variables are:

Placeholder Description Example
$name Name of the device.

The device ID is displayed if there is no name.
Fridge 3
$description Description of the device. Mounted on the top of the fridge.
$deviceID The ID of the device. bivd53b1e97600enrts0
$celsius The temperature (°C). 12.70°C
$fahrenheit The temperature (°F). 12.70°F
$relativeHumidity The humidity (%RH). 87 %RH
$proximityStatus The status displayed in Studio for proximity sensors ("open" or "closed") Closed
$objectPresent The status displayed in the API for proximity sensors ("not present" or "present") not present
$waterPresent  The status displayed in Studio for water sensors ("water present" or "no water present")
no water present
$label.{labelKey} The value of a Label for a device. If a device has a Label where Key=room and value=34A, then $label.room displays the value 34A
$deskOccupancy The status displayed in Studio for Desk Occupancy sensors ("occupied" or "not occupied") Not occupied
$motion The status displayed in Studio for Motion sensors ("motion detected" or "no motion detected") No motion detected

$co2

CO2 sensor value in PPM

1000 PPM

$triggerStatus

Can be used if the “Resolved Notification” toggle is enabled where a notification is sent when the trigger is resolved. $triggerStatus will then either be “Triggering” or “Resolved”. Resolved

How to include the Studio link in the email

It can be valuable to have a link in the notification email for quick access to the sensor details in Studio. A simple way to achieve this is to put the link (URL) for the sensor in the description field of the sensor and include it in the message.

Step 1 - Add the sensor link (URL) to the sensor description

  1. Open the detailed view for a device in Studio
  2. Copy the URL from the browser address (typically at the top)
  3. Paste the URL into the description field for the sensor

Step 2 - Include the description field in the email

  1. Open the Notification rule
  2. Go to the "Send Email" section
  3. Include the $description placeholder in the Email body. It should look something like this:
    mceclip4.png
  4. Save by selecting "Update Notification"
  5. Emails sent out will now include a link to the device in Studio

Note that the recipient needs a Studio account to access the device and that you could do a similar approach using Labels. 

Tip - emulated sensors

Use emulated sensors to test out your notifications with different values.