Use an external sensor in AQURA

THC_AQURA

Exported on  07/14/2022

 THC_AQURA  –  Use an external sensor in AQURA

Table of Contents
1 Configuring sensortypes........................................................................................ 4
1.1 Creating a Sensortype.................................................................................................................. 4
1.2 Deleting a sensortype*................................................................................................................. 6
1.3 Editing a sensortype .................................................................................................................... 6
2 Configuring sensors ............................................................................................... 7
2.1 Creating a sensor ......................................................................................................................... 7
2.1.1 Manually creating a sensor......................................................................................................................................... 7
2.1.2 Manually creating a sensor in bulk............................................................................................................................. 7
2.1.3 Scanning/assigning a sensor ...................................................................................................................................... 7
2.2 Editing a sensor............................................................................................................................ 8
2.3 Deleting a sensor.......................................................................................................................... 8
3 Sensor Assignment .............................................................................................. 12
3.1 Assigning a sensor manually ..................................................................................................... 12
3.2 Unassigning a sensor ................................................................................................................. 12
4 Call Changes ......................................................................................................... 16
4.1 Changes to unique identifier ..................................................................................................... 16
4.2 Cancelling calls based on Presence .......................................................................................... 16

 –  2
 THC_AQURA  –  Use an external sensor in AQURA

Supported starting AQURA R3.2

 –  3
 THC_AQURA  –  Use an external sensor in AQURA

1 Configuring sensortypes

1.1  Creating a Sensortype

1. Log in and then select the sensorTypes subtab from the system tab.
2. At the top of the table, click '+ Add SensorType'.
3. Fill out the form.
i. Choose a unique name for the sensortype
ii. Enter the vendor name
iii. (Optional) Fill in a description for the sensortype
iv. (Optional) Select an image for the sensortype
v. Select if the sensors of this type can be assigned to a room or a person.
vi. Select if the sensor is scannable*
vii. Select if a sensortype can be cancelled by a presence event. Only selectable if the sensortype
is assignable to a room.
4. Press save once ready. 
5. If successful, the newly created sensortype will be added to the table. 

Configuring sensortypes –  4
THC_AQURA  –  Use an external sensor in AQURA

Configuring sensortypes –  5
 THC_AQURA  –  Use an external sensor in AQURA

1.2 Deleting a sensortype*

1. From the sensorTypes subtab click the three dots 
2. Select Delete
3. Confirm or cancel the deletion on the popup screen
* It's only possible to delete a sensortype if no sensors of that type exists.

1.3 Editing a sensortype

1. From the sensorTypes subtab click the three dots 
2. Select Edit
3. Fill out the form. It's possible to change the following if no sensors have been assigned: 
i. Picture
ii. Name
iii. Vendor
iv. Description
v. Is Scannable
vi. Is Cancelled By Presence
4. If sensors have been assigned already, it's not possible to change the following: 
i. Is Scannable
ii. Is Cancelled By Presence
5. Click Save.

Configuring sensortypes –  6
 THC_AQURA  –  Use an external sensor in AQURA

2 Configuring sensors

2.1 Creating a sensor

There are three ways of creating a sensor. You can create them manually, create them in bulk or scan a scannable
sensor.

2.1.1 Manually creating a sensor

1. If manually creating a sensor, make sure to have created a sensortype that is not scannable.
2. In the system tab navigate to the Sensors subtab. 
3. Click the Add Sensor button. 
4. Fill out the form.
i. Choose a unique name for the sensor
ii. Select a specific ward where the sensor will be limited to, or select System to have it be
available for every ward.
iii. Select the sensortype, only nonscannable sensors will be visible
iv. Select the input ID. This is a unique ID or tag that is used to identify the Sensor when calls are
made.
5. Click save.

2.1.2 Manually creating a sensor in bulk

1. In the system tab navigate to the Sensors subtab. 
2. Click the Multiple Sensors button. 
3. Fill out the form.
i. Choose the amount of sensors to create
ii. Select a specific ward where the sensors will be limited to, or select System to have them be
available for every ward.
iii. Select the sensortype, only nonscannable sensors will be visible.
iv. In order to create the name of the sensors a number will be used in ascending order. You can
provide a prefix and a suffix in addition to the starting number.
v. Select the Input ID for every sensor.
4. Click save.

2.1.3 Scanning/assigning a sensor

In order to create a sensor in this manner, it needs to be of a scannable sensortype. These only exist for as long as
they are assigned and are deleted when unassigned. 
1. Navigate to the residents tab or the rooms tab/subtab, depending on how the sensor is configured. 
2. Click the three dots under actions on the room/person you would like to scan a sensor to. 
3. Click assign sensor
4. Click the sensortype you wish to create a sensor of, in this case of a scannable type
5. The screen now prompts you to scan the sensor.
a. Alternatively, if you wish to type the ID, click the underlined text on the screen to switch to manual
input.
b. Click assign.
6. If successfully assigned, you can now optionally add a name to this sensor.

Configuring sensors –  7
 THC_AQURA  –  Use an external sensor in AQURA

a. It is possible that the sensor is already assigned to another person/room. In this case it is possible to
try and scan another sensor with the 'Scan new Sensor' button, or to forcibly reassign the sensor with
the Force Unassign button. 

2.2 Editing a sensor

1. Navigate to the sensors subtab under the system.
2. Click the three dots under actions and click Edit.
3. Change the name if desired.
4. If the sensor is not assigned, change the ward if desired.
5. Click save.

2.3 Deleting a sensor

1. Navigate to the sensors subtab under the system.
2. Click the three dots under actions and click Delete.
3. Confirm or cancel the decision on the following popup.

Configuring sensors –  8
THC_AQURA  –  Use an external sensor in AQURA

Configuring sensors –  9
THC_AQURA  –  Use an external sensor in AQURA

Configuring sensors –  10
THC_AQURA  –  Use an external sensor in AQURA

Configuring sensors –  11
 THC_AQURA  –  Use an external sensor in AQURA

3 Sensor Assignment
There are two ways to assign a sensor, one for a nonscannable sensor and one for scannable sensors.

3.1 Assigning a sensor manually

1. Navigate to the page where you would like to assign something to. This is either the residents tab or the
rooms tab.
2. Click on the three dots under the action menu. 
3. Select 'Assign Sensor'.
4. Select the sensortype you wish to assign A symbol next to the name indicates if it is a scannable or
nonscannable sensortype. A scanning symbol for the former and a keyboard for the latter.
a. (Scannable) See 2.1.3
5. (Nonscannable) Select a nonscannable type.
6. Select the sensor to assign to this person/room from the list of sensors. 
7. If no sensors are available, then there are no sensors for this sensortype and the assigned ward. 
8. Press select.
9. Press Finish.

3.2 Unassigning a sensor

It is important to note that when a scannable sensor is unassigned, it is also deleted from the system. Likewise,
when a sensor is deleted it is also unassigned. 
1. Navigate to either the residents tab or the rooms tab
2. Click on the three dots under the action menu
3. Select Unassign Sensor
4. Select the sensor you wish to unassign and click the trashcan icon.
5. Confirm or cancel the selection on the following screen.

Sensor Assignment –  12
THC_AQURA  –  Use an external sensor in AQURA

Sensor Assignment –  13
THC_AQURA  –  Use an external sensor in AQURA

Sensor Assignment –  14
 THC_AQURA  –  Use an external sensor in AQURA

If this external sensor now triggers a call on out system:

Based upon the SensorId and Vendor field provided in a call object, the call service will enrich the call with room or
person information as if the call was generated from one of our own devices.
Currently the links with external sensors are made through the external Api or Flow plugins (Emfit, Vayyar)

Sensor Assignment –  15
 THC_AQURA  –  Use an external sensor in AQURA

4  Call Changes

4.1 Changes to unique identifier

The unique identifier needed to save a call has been expanded to include the inputID and the vendor. This change
makes it possible to have multiple calls from the same room from different sources. 
The call message field is also changed to check if the sensor is filled in or not. If it is, then the message will be
changes to include the sensor vendor in front of the original text to indicate the origin.

4.2 Cancelling calls based on Presence

Based on how the sensortype has been configured, calls from this sensor (i.e. with the sensor fields filled in) can be
cancelled with a presence event on the room they are linked to. If they are configured to not be cancelled by a
presence event, they can only be cancelled manually in the active calls subtab from system or from a call on the API
that triggers the stopcall.

 Call Changes –  16