Logo of the PureLife brand of PureSec GmbH
API docs by Redocly

PureLife Cloud API Reference (3.0.0)

Download OpenAPI specification:

PureSec GmbH: support@puresec.de URL: https://smart-altern.de/ License: private

PureLife Cloud API Reference

introduction

The PureLife Cloud Web Services API is used by clients and third party applications to interact with the PureLife Cloud.

Support

Bug reports in the documentation or the API are welcome.

schema

All API access is through HTTP(S) requests at your-cloud-url.com/api/v1. Unless otherwise specified, all response bodies have the content type application/json.

When using endpoints that require a user id, the string me can be used in place of the user id to indicate the action is to be taken for the logged in user.

authentication

There are multiple ways to authenticate against the PureLife Cloud.

All examples assume that a PureLife Cloud instance at https://vayyar-cloud.smart-altern.de is used.

Session Token

Make an HTTP POST to vayyar-cloud.smart-altern.de/api/v1/users/login with a JSON body indicating the user’s username and password.

curl -i -H 'Content-Type: application/json' \
     -d '{"username":"someone","password":"this-is-a-password"}' \
     -X POST \
     https://vayyar-cloud.smart-altern.de/api/v1/users/login

If successful, the response will contain a Token header and a user object in the body.

HTTP/1.1 200 OK
Cache-Control: no-cache, no-store, must-revalidate
Content-Type: application/json
Set-Cookie: PSAUTHTOKEN=U113GPXYR38JMNMJXXEJQ19U1E; Path=/; Expires=Wed, 19 Mar 2025 09:31:10 GMT; Max-Age=86400; HttpOnly; SameSite=Lax
Set-Cookie: PSUSERID=10; Path=/; Expires=Wed, 19 Mar 2025 09:31:10 GMT; Max-Age=86400; SameSite=Strict
Set-Cookie: PSCSRF=FR3MAQDBITNI58UG8NUISQASCY; Path=/; Expires=Wed, 19 Mar 2025 09:31:10 GMT; Max-Age=86400; SameSite=Strict
Token: U113GPXYR38JMNMJXXEJQ19U1E
Vary: Origin
Vary: Accept-Encoding
X-Content-Type-Options: nosniff
X-Frame-Options: deny
X-Ratelimit-Limit: 31
X-Ratelimit-Remaining: 30
X-Ratelimit-Reset: 1
X-Version-Id: 0.0.0-dev
Date: Tue, 18 Mar 2025 09:31:10 GMT
Content-Length: 504

{{user object as json}}

Include the Token as part of the Authorization header on your future API requests with the Bearer method.

curl -i -H 'Authorization: Bearer U113GPXYR38JMNMJXXEJQ19U1E' https://vayyar-cloud.smart-altern.de/api/v1/users/me

You should now be able to access the API as the user you logged in as.

Cookies

If your client supports the use of cookies, the cookies that are set during login can be used for authentication. For this, it is necessary that the cookie with the name 'PSAUTHTOKEN' is sent with all requests.

Access Tokens

Using access tokens is very similar to using a session token. The only real difference is that session tokens will expire, while access tokens will live until they are manually revoked by the user or an admin.

Just like session tokens, include the access token as part of the Authorization header in your requests using the Bearer method. Assuming our access token is KYHONWTI6BR9JQ9SYP65X81A7H, we could use it as shown below.

curl -i -H 'Authorization: Bearer KYHONWTI6BR9JQ9SYP65X81A7H' https://vayyar-cloud.smart-altern.de/api/v1/users/me

Session Lifetime

As soon as the PureLife Cloud responds with the HTTP status code 401, the session is no longer valid and can no longer be used. A new login is required to start a new session.

errors

All errors will return an appropriate HTTP response code along with the following JSON body:

{
    "message": "Something went wrong", // the reason for the error
    "statusCode": 0, // the HTTP status code
}

csrf protection

The following section is only relevant if cookies are used as the authentication method. For all other authentication methods, this section can be ignored

The PureLife Cloud has protection against CSRF attacks. For this purpose, it is necessary to read and save the value of the PSCSRF cookie after logging in. For each subsequent request, with the exception of requests with the GET verb, an X-CSRF-Token header must be added with the token from the cookie.

If, for example, a POST request is to be executed and the PSCSRF cookie had the value FR3MAQDBITNI58UG8NUISQASCY at login, then the header X-CSRF-Token: FR3MAQDBITNI58UG8NUISQASCY must be added to the request.

rate limiting

Whenever you make an HTTP request to the PureLife Cloud API you might notice the following headers included in the response:

X-Ratelimit-Limit: 10
X-Ratelimit-Remaining: 9
X-Ratelimit-Reset: 1441983590

These headers are telling you your current rate limit status.

Header Description
X-Ratelimit-Limit The maximum number of requests you can make per second.
X-Ratelimit-Remaining The number of requests remaining in the current window.
X-Ratelimit-Reset The remaining UTC epoch seconds before the rate limit resets.

If you exceed your rate limit for a window you will receive the following error in the body of the response:

HTTP/1.1 429 Too Many Requests
Date: Tue, 18 Mar 2025 09:38:10 GMT
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1

{
  "message":"Too many requests. Next attempt possible in: 6 seconds from now",
  "statusCode":429
}

common parameters

For all endpoints that implement pagination via the perPage parameter, the maximum number of items returned per request is capped at 200. If perPage exceeds 200, the list will be silently truncated to 200 items. If a paged API requires a perPage parameter and it is not provided, the default value is 30.

users

Endpoints for creating, getting and interacting with users. When using endpoints that require a user id, the string me can be used in place of the user id to indicate the action is to be taken for the logged in user.

Login to PureLife Cloud server

Permissions

No permission required

Request Body schema: application/json
required

User authentication object

id
number or null <int64>
username
required
string
password
required
string

The password used for authentication.

Responses

Request samples

Content type
application/json
{
  • "username": "john",
  • "password": "my-secret-password"
}

Response samples

Content type
application/json
{
  • "id": 203,
  • "createDate": 1659698159000,
  • "updateDate": 1742308310590,
  • "customerId": 102,
  • "username": "john",
  • "firstName": "John",
  • "lastName": "Doe",
  • "email": "john.doe@example.org",
  • "locale": "en",
  • "telegramId": null,
  • "mobileNumber": null,
  • "profileImageId": "c4fcf354-309e-4d20-86fb-7970b1f19a24",
  • "canLogin": true,
  • "isAdmin": false,
  • "permissions": [
    • "manage_users"
    ]
}

Logout from the PureLife Cloud server

Permissions

An active session is required

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}

Get a user

Get a user a object. Sensitive information will be sanitized out.

Permissions

The session user wants to load himself or the session user must belong to the same customer as the user object and have the permission manage_users.

path Parameters
userId
required
string

ID of the user to be retrieved. This can also be "me" which will point to the current user.

Request Body schema: application/json
Schema not provided

Responses

Response samples

Content type
application/json
{
  • "id": 203,
  • "createDate": 1659698159000,
  • "updateDate": 1742308310590,
  • "customerId": 102,
  • "username": "john",
  • "firstName": "John",
  • "lastName": "Doe",
  • "email": "john.doe@example.org",
  • "locale": "en",
  • "telegramId": null,
  • "mobileNumber": null,
  • "profileImageId": "c4fcf354-309e-4d20-86fb-7970b1f19a24",
  • "canLogin": true,
  • "isAdmin": false,
  • "permissions": [
    • "manage_users"
    ]
}

Pair a sensor

Links a sensor to a user.

Permissions

The user wants to link the sensor to themselves or the session user must belong to the same customer as the user object and have the permission manage_users.

path Parameters
userId
required
string

ID of the user with which the sensor is to be linked. This can also be "me" which will point to the current user.

Request Body schema: application/json
One of
code
required
string = 8 characters

Code that the Vayyar sensor transmits to the provisioning device during provisioning.

Responses

Request samples

Content type
application/json
Example
{
  • "code": "38909714"
}

Response samples

Content type
application/json
{
  • "status": "OK"
}

customers

Endpoints for creating, getting and updating customers.

Get all customers

Returns a list of available customers.

Permissions

Only available for system admins.

Responses

Response samples

Content type
application/json
[
  • {
    • "id": 102,
    • "createDate": 1659698159000,
    • "updateDate": 1742308310590,
    • "name": "Smart Company",
    • "location": "Smart city",
    • "email": "user@example.com"
    }
]

Get a customer

Get a customer a object.

Permissions

The user's session must belong to the same customer as the one to be loaded.

path Parameters
customerId
required
number <int64> >= 1

Unique ID of the customer to get

Responses

Response samples

Content type
application/json
{
  • "id": 102,
  • "createDate": 1659698159000,
  • "updateDate": 1742308310590,
  • "name": "Smart Company",
  • "location": "Smart city",
  • "email": "user@example.com"
}

sensors

Endpoints for getting and updating sensors.

Get sensors

Returns a list of available sensors.

Permissions

An active session is required.

query Parameters
page
integer
Default: 0

The page to select.

perPage
integer
Default: 30

The number of sensors per page.

searchText
string
Default: ""

Searches various strings related to the sensor for the specified text.

sortBy
string
Default: "asc(name)"
Enum: "asc(id)" "desc(id)" "asc(name)" "desc(name)" "asc(isActive)" "desc(isActive)" "asc(createDate)" "desc(createDate)" "asc(updateDate)" "desc(updateDate)"

Defines the attributes according to which the list is to be sorted.

isActive
boolean or null
  • Setting this to true will only return active sensors.
  • Setting this to false will only return inactive sensors.
  • Leave blank to show all sensors.
customerId
number <int64>

The ID of the customer for whom the sensors are to be loaded.

This parameter is only available for system admin users. For all non-admin users, the customer to which the user is linked is always used.

Responses

Request samples 

curl -i -H 'Authorization: Bearer U113GPXYR38JMNMJXXEJQ19U1E' \
	https://vayyar-cloud.smart-altern.de/api/v1/sensors

Response samples

Content type
application/json
[
  • {
    • "total": 1,
    • "page": 0,
    • "perPage": 30,
    • "data": [
      • {
        }
      ]
    }
]

Get room

Returns the room configuration of the sensor.

A room does not represent a physical room, but the detection area of the sensor.

Layout

A room describes a coordinate system with the sensor as the origin, i.e. the point (0,0). The limits of the coordinate system are the limits of the physical detection range of the sensor. A point P within this coordinate system is always described by a tuple of two numbers (x, y).

xMin
xMin
yMax
yMax
yMin
yMin
xMax
xMax
Sensor
P(0, 0)
SensorP(0,...

If for example the value xMax is 200 cm, the sensor monitors 200 cm of the area to the right of it.

Region

A region describes two coordinate points of a square within the room coordinate system. Always the upper left (TL) and lower right (BR) coordinate points are used.

TL
TL
BR
BR

The coordinates of the points are always specified in relation to the origin, i.e. the sensor.

xMin
xMin
yMax
yMax
Sensor
(0, 0)
Sensor(0,...
(-40, 60)
TL
(-40, 60...
BR
(-20, 30)
BR...

Permissions

The session user must belong to the same customer as the sensor.

path Parameters
sensorId
required
string

ID of the sensor for which the room is to be got

Request Body schema: application/json
Schema not provided

Responses

Response samples

Content type
application/json
{
  • "sensorId": "id_MzA6QUU6QTQ6RTM6RjI6OEM",
  • "createDate": 1659698159000,
  • "updateDate": 1742308310590,
  • "sensorMounting": "ceiling",
  • "xMin": 180,
  • "xMax": 180,
  • "yMax": 200,
  • "yMin": 50,
  • "zMin": 0,
  • "zMax": 180,
  • "sensorHeight": 150,
  • "enterDuration": 120,
  • "exitDuration": 120,
  • "rotation": 0.1,
  • "regions": [
    • {
      • "id": "a7f07121-e084-45c8-a61f-4a5c80a13a24",
      • "kind": "door",
      • "positionIdx": 0,
      • "name": "Bed",
      • "topLeftX": -40,
      • "topLeftY": 60,
      • "bottomRightX": -20,
      • "bottomRightY": 30,
      • "zMin": 0,
      • "zMax": 1,
      • "enterDuration": 1,
      • "exitDuration": 1,
      • "fallDetectionEnabled": true,
      • "presenceDetectionEnabled": true,
      • "isLowSnr": true,
      • "isHorizontal": true
      }
    ]
}

Update room

Updates the room configuration of the sensor.

Permissions

The session user must belong to the same customer as the sensor and have the permission edit_sensor_room.

path Parameters
sensorId
required
string

ID of the sensor for which the room is to be updated

Request Body schema: application/json
required

The new room configuration to be used.

sensorMounting
required
string (Mounting)
Enum: "wall" "ceiling" "ceiling_45deg" "wall_tilt_45deg"

Defines how and where the sensor is mounted.

The supported values differ depending on the parameter manufacturer of the sensor as follows:

  • vayyar: All
  • qinglan: [ "wall", "ceiling"]
xMin
required
integer <int32> >= 20

Monitored area to the left of the sensor in cm.

Describes the expansion of the X-axis into the negative range (left), but not its minimum value. For an X-axis with the minimum value -200, you must therefore send 200 (without minus).

The possible value are limited by the parameter sensorMounting and the parameter manufacturer of the sensor as follows:

  • vayyar
    • wall or wall_tilt_45deg: [ 30 .. 200 ]
    • ceiling or ceiling_45deg: [ 30 .. 250 ]
  • qinglan: [ 20 .. 300 ]
xMax
required
integer <int32> >= 20

Monitored area to the right of the sensor in cm.

The possible value are limited by the parameter sensorMounting and the parameter manufacturer of the sensor as follows:

  • vayyar
    • wall or wall_tilt_45deg: [ 30 .. 200 ]
    • ceiling or ceiling_45deg: [ 30 .. 250 ]
  • qinglan: [ 20 .. 300 ]
yMax
required
integer <int32> >= 20

Monitored area to the front in cm.

"Front" is in the direction of the button for ceiling mounting and in the direction of the LED for wall mounting.

The possible value are limited by the parameter sensorMounting and the parameter manufacturer of the sensor as follows:

  • vayyar
    • wall or wall_tilt_45deg: [ 30 .. 400 ]
    • ceiling or ceiling_45deg: [ 30 .. 200 ]
  • qinglan
    • wall: [ 20 .. 400 ]
    • ceiling: [ 20 .. 200 ]
yMin
required
integer <int32> [ 20 .. 200 ]

Monitored area in direction of cable in cm.

Describes the expansion of the Y-axis into the negative range (down), but not its minimum value. For an Y-axis with the minimum value -200, you must therefore send 200 (without minus).

Only supported if sensorMounting equals "ceiling" or "ceiling_45deg". For other values, this parameter is automatically set to 0.

The possible value are limited by the parameter manufacturer of the sensor as follows:

  • vayyar: [ 30 .. 200 ]
  • qinglan: [ 20 .. 200 ]
zMin
required
integer <int32> [ 0 .. 180 ]
Default: 0

Specifies the minimum height to be monitored within the room in centimeters from the floor.

The value must be less than the value of parameter zMax. So zMin < zMax.

Only affects Vayyar sensors.

zMax
required
integer <int32> [ 0 .. 180 ]
Default: 180

Specifies the maximum height to be monitored within the room in centimeters from the floor.

The value must be greater than the value of parameter zMin. So zMin < zMax.

Only affects Vayyar sensors.

sensorHeight
required
integer <int32>

Specifies the mounting height of the sensor above the floor in cm.

The possible value are limited by the parameter sensorMounting and the parameter manufacturer of the sensor as follows:

  • vayyar
    • wall or wall_tilt_45deg: [ 150 .. 300 ]
    • ceiling or ceiling_45deg: [ 200 .. 320 ]
  • qinglan
    • wall: [ 150 .. 330 ]
    • ceiling: [ 200 .. 330 ]
enterDuration
required
integer <int32> [ 1 .. 300 ]
Default: 120

Time in seconds that the sensor takes to detect whether a person has entered the detection area.

The lower the value, the faster the sensor detects whether the detection area has been entered, but the higher the risk of false detection.

Only affects Vayyar sensors.

exitDuration
required
integer <int32> [ 1 .. 300 ]
Default: 120

The time in seconds that the sensor takes to detect all persons leaving the detection area.

The lower the value, the faster the sensor detects whether the detection area has been vacated, but the higher the risk of false detection.

Only affects Vayyar sensors.

required
Array of objects (Region) >= 0 items

Separate regions within the sensor detection range.

The number of possible regions is limited by the manufacturer parameter of the sensor as follows:

  • vayyar: [ 0 .. 6 ]
  • qinglan: [ 0 .. 16 ]

The following restrictions apply only to Vayyar:

  1. The bed region must always be the first region (index = 0)
  2. There may be a maximum of two door regions
Array (>= 0 items)
id
string <uuid>

Unique ID of the region.

If the region ID is set during an update, the region is updated, otherwise a new region is created.

kind
required
string (RegionKind)
Default: ""
Enum: "" "bed" "door" "seating" "bathroom"

Describes the type of region.

The supported values differ depending on the parameter sensorMounting and the parameter manufacturer of the sensor as follows:

  • vayyar:
    • wall or wall_tilt_45deg: [ "", "seating", "bathroom"]
    • ceiling or ceiling_45deg: All
  • qinglan: [ "", "bed", "door" ]
name
required
string [ 1 .. 32 ] characters
Default: ""

Name to identify the sensor.

Each region name may only be used once per sensor.

If no region name is specified, a name is generated.

topLeftX
required
integer <int32>

Distance on the X-axis from the sensor/origin to the top left corner in cm.

The following limitations apply:

  • topLeftX < bottomRightX
  • topLeftX < room.xMax
  • topLeftX >= room.xMin
topLeftY
required
integer <int32>

Distance on the Y-axis from the sensor/origin to the top left corner in cm.

The following limitations apply:

  • topLeftY > bottomRightY
  • topLeftY <= room.yMax
  • topLeftY > room.yMin
bottomRightX
required
integer <int32>

Distance on the X-axis from the sensor/origin to the bottom right corner in cm.

The following limitations apply:

  • bottomRightX > topLeftX
  • bottomRightX <= room.xMax
  • bottomRightX > room.xMin
bottomRightY
required
integer <int32>

Distance on the Y-axis from the sensor/origin to the bottom right corner in cm.

The following limitations apply:

  • bottomRightY < topLeftY
  • bottomRightY < room.yMax
  • bottomRightY >= room.yMin
zMin
required
integer <int32> [ 0 .. 170 ]
Default: 0

This value is always set to 0 if the parameter kind has the value door.

Only affects Vayyar sensors.

zMax
required
integer <int32> [ 1 .. 180 ]

This value is always set to 180 if the parameter kind has the value door.

Only affects Vayyar sensors.

enterDuration
required
integer <int32> [ 1 .. 300 ]

Time in seconds that the sensor takes to detect whether a person has entered the region.

The lower the value, the faster the sensor detects whether the room has been entered, but the higher the risk of false detection.

Only affects Vayyar sensors.

exitDuration
required
integer <int32> [ 1 .. 300 ]

The time in seconds that the sensor takes to detect all persons leaving the region.

The lower the value, the faster the sensor detects whether the region has been vacated, but the higher the risk of false detection.

Only affects Vayyar sensors.

fallDetectionEnabled
required
boolean

If false, the region is excluded from fall detection.

This value is always set to:

  • true if the parameter kind has the value door.
  • false if the parameter kind has the value bed.
presenceDetectionEnabled
required
boolean

If false, the region is excluded from presence detection.

This value is always set to true if the parameter kind has the value door or bed.

Only affects Vayyar sensors.

isLowSnr
required
boolean

Only affects Vayyar sensors.

This value is always set to:

  • true if the parameter kind has the value bed or seating.
  • false if the parameter kind has the value door or bathroom.
isHorizontal
required
boolean

Only affects Vayyar sensors.

Responses

Request samples

Content type
application/json
{
  • "sensorMounting": "ceiling",
  • "xMin": 180,
  • "xMax": 180,
  • "yMax": 200,
  • "yMin": 50,
  • "zMin": 0,
  • "zMax": 180,
  • "sensorHeight": 150,
  • "enterDuration": 120,
  • "exitDuration": 120,
  • "regions": [
    • {
      • "id": "a7f07121-e084-45c8-a61f-4a5c80a13a24",
      • "kind": "door",
      • "name": "Bed",
      • "topLeftX": -40,
      • "topLeftY": 60,
      • "bottomRightX": -20,
      • "bottomRightY": 30,
      • "zMin": 0,
      • "zMax": 1,
      • "enterDuration": 1,
      • "exitDuration": 1,
      • "fallDetectionEnabled": true,
      • "presenceDetectionEnabled": true,
      • "isLowSnr": true,
      • "isHorizontal": true
      }
    ]
}

Response samples

Content type
application/json
{
  • "sensorId": "id_MzA6QUU6QTQ6RTM6RjI6OEM",
  • "createDate": 1659698159000,
  • "updateDate": 1742308310590,
  • "sensorMounting": "ceiling",
  • "xMin": 180,
  • "xMax": 180,
  • "yMax": 200,
  • "yMin": 50,
  • "zMin": 0,
  • "zMax": 180,
  • "sensorHeight": 150,
  • "enterDuration": 120,
  • "exitDuration": 120,
  • "rotation": 0.1,
  • "regions": [
    • {
      • "id": "a7f07121-e084-45c8-a61f-4a5c80a13a24",
      • "kind": "door",
      • "positionIdx": 0,
      • "name": "Bed",
      • "topLeftX": -40,
      • "topLeftY": 60,
      • "bottomRightX": -20,
      • "bottomRightY": 30,
      • "zMin": 0,
      • "zMax": 1,
      • "enterDuration": 1,
      • "exitDuration": 1,
      • "fallDetectionEnabled": true,
      • "presenceDetectionEnabled": true,
      • "isLowSnr": true,
      • "isHorizontal": true
      }
    ]
}

Get regions

Returns the regions that have been configured for the sensor's room.

Permissions

The session user must belong to the same customer as the sensor.

path Parameters
sensorId
required
string

ID of the sensor for which the regions is to be got

Responses

Response samples

Content type
application/json
[
  • {
    • "id": "a7f07121-e084-45c8-a61f-4a5c80a13a24",
    • "kind": "door",
    • "positionIdx": 0,
    • "name": "Bed",
    • "topLeftX": -40,
    • "topLeftY": 60,
    • "bottomRightX": -20,
    • "bottomRightY": 30,
    • "zMin": 0,
    • "zMax": 1,
    • "enterDuration": 1,
    • "exitDuration": 1,
    • "fallDetectionEnabled": true,
    • "presenceDetectionEnabled": true,
    • "isLowSnr": true,
    • "isHorizontal": true
    }
]

Delete sensor

Permanent delete a sensor. The sensor to be deleted must be inactive.

Permissions

The session user must belong to the same customer as the sensor and have the permission manage_sensors.

path Parameters
sensorId
required
string [ 12 .. 26 ] characters

ID of the sensor that needs to be deleted

Responses

Response samples

Content type
application/json
{
  • "status": "OK"
}

sensors vayyar

Endpoints for retrieving and updating data, especially for Vayyar sensors.

These end points are only available if the parameter manufacturer of the sensor has the value vayyar.

Get basic config

Returns the basic configuration of a Vayyar sensor.

Permissions

The session user must belong to the same customer as the sensor and have the permission manage_sensors.

path Parameters
sensorId
required
string = 26 characters

ID of the sensor for which the configuration is to be updated

Request Body schema: application/json
Schema not provided

Responses

Response samples

Content type
application/json
{
  • "name": "Living room",
  • "volume": 0,
  • "ledMode": 0,
  • "learningModeEnabled": false,
  • "learningModeEndDate": null,
  • "testModeEnabled": false,
  • "fallingMitigatorEnabled": true,
  • "optimizationEnabled": true
}

Update basic config

Updates the basic configuration of a Vayyar sensor.

Permissions

The session user must belong to the same customer as the sensor and have the permission manage_sensors.

path Parameters
sensorId
required
string = 26 characters

ID of the sensor for which the configuration is to be retrieved

Request Body schema: application/json
required

The new configuration to be used.

name
required
string [ 3 .. 64 ] characters
volume
required
integer <int32> [ 0 .. 100 ]
Default: 0

Sets the volume of the beep in the event of a fall. Can be deactivated with volume 0.

ledMode
required
integer <int32> (VayyarLedMode)
Enum: 0 1 2

Specifies how the sensor LED should behave.

  • 0 - The LED only lights up for errors
  • 1 - The LED lights up for all events
  • 2 - The LED never lights up.

Option 3 is not supported by all firmware versions. If it is specified for a non-supported version, option 0 is sent to the sensor.

learningModeEnabled
required
boolean
Default: false

Set to true to activate the learning mode.

The learning phase lasts for 14 days. When the learning phase is completed, a sensitivity map customised for the room and sensor is created, through which the fall detection can be improved. After changing the room configuration, the learning phase should be restarted.

This value is always set to false if the parameter optimizationEnabled is also set to false, as the learning mode then has no effect on the behavior of the sensor.

By starting the learning phase, the active sensitivity map and the associated data are discarded and no longer used.

testModeEnabled
required
boolean
Default: false

When true, fall events that occur are registered as test falls and thus do not affect the learning phase or the creation of the sensitivity map.

It is recommended to set the value to true for installations in model apartments or similar.

This value is always set to false if the parameter optimizationEnabled is also set to false, as the test mode then has no effect on the behavior of the sensor.

Supported from firmware version v0.31.

fallingMitigatorEnabled
required
boolean
Default: false

If true an alternative fall detection algorithm is used.

It uses machine learning to reduce false alarm rates by up to 50%. It may also have a reduction of up to 5% in real fall detections.

Supported from firmware version v0.40.

optimizationEnabled
required
boolean
Default: true

If true, the sensor data are forwarded to the manufacturer so that he can generate a sensitivity map.

Responses

Request samples

Content type
application/json
{
  • "name": "Living room",
  • "volume": 0,
  • "ledMode": 0,
  • "learningModeEnabled": false,
  • "testModeEnabled": false,
  • "fallingMitigatorEnabled": true,
  • "optimizationEnabled": true
}

Response samples

Content type
application/json
{
  • "name": "Living room",
  • "volume": 0,
  • "ledMode": 0,
  • "learningModeEnabled": false,
  • "learningModeEndDate": null,
  • "testModeEnabled": false,
  • "fallingMitigatorEnabled": true,
  • "optimizationEnabled": true
}

Get dry contact config

Returns the dry contact configuration of a Vayyar sensor.

Permissions

The session user must belong to the same customer as the sensor and must have the permission edit_sensor_config.

path Parameters
sensorId
required
string = 26 characters

ID of the sensor for which the configuration is to be retrieved

Responses

Response samples

Content type
application/json
{
  • "primaryMode": 0,
  • "primaryPolicy": 0,
  • "secondaryMode": 0,
  • "secondaryPolicy": 0,
  • "activationDurationSec": 30
}

Update dry contact config

Updates the dange configuration of a Vayyar sensor.

Permissions

The session user must belong to the same customer as the sensor and have the permission edit_sensor_config.

path Parameters
sensorId
required
string = 26 characters

ID of the sensor for which the configuration is to be updated

Request Body schema: application/json
required

The new configuration to be used.

primaryMode
required
integer <int32> (VayyarDryContactMode)
Enum: 0 1

Defines how the dry contact is to be triggered.

  • 0 - Opener: The dry contact is normally closed and is opened when an alarm occurs.
  • 1 - Closer: The dry contact is open in the normal state and is closed when an alarm occurs.
primaryPolicy
required
integer <int32> (VayyarDryContactPolicy)
Enum: 0 1 2 3 4 6

Defines which event should trigger the dry contact.

  • 0 - Off: No dry contact alert
  • 1 - On fall: The dry contact alert will be triggered when the device reaching the calling stage
  • 2 - On out of bed
  • 3 - On sensitive fall: The dry contact alert will be triggered when the device reaching the calling stage
  • 4 - On any fall: The dry contact alert will be triggered when the device reaching the calling stage
  • 6 - On door exit
secondaryMode
required
integer <int32> (VayyarDryContactMode)
Enum: 0 1

Defines how the dry contact is to be triggered.

  • 0 - Opener: The dry contact is normally closed and is opened when an alarm occurs.
  • 1 - Closer: The dry contact is open in the normal state and is closed when an alarm occurs.
secondaryPolicy
required
integer <int32> (VayyarDryContactPolicy)
Enum: 0 1 2 3 4 6

Defines which event should trigger the dry contact.

  • 0 - Off: No dry contact alert
  • 1 - On fall: The dry contact alert will be triggered when the device reaching the calling stage
  • 2 - On out of bed
  • 3 - On sensitive fall: The dry contact alert will be triggered when the device reaching the calling stage
  • 4 - On any fall: The dry contact alert will be triggered when the device reaching the calling stage
  • 6 - On door exit
activationDurationSec
required
integer <int32> [ 1 .. 300 ]
Default: 30

The time that the dry contact will be activated when a fall is detected.

Supported from firmware version v0.40.

Responses

Request samples

Content type
application/json
{
  • "primaryMode": 0,
  • "primaryPolicy": 0,
  • "secondaryMode": 0,
  • "secondaryPolicy": 0,
  • "activationDurationSec": 30
}

Response samples

Content type
application/json
{
  • "primaryMode": 0,
  • "primaryPolicy": 0,
  • "secondaryMode": 0,
  • "secondaryPolicy": 0,
  • "activationDurationSec": 30
}

Get firmware config

Returns the firmware configuration of a Vayyar sensor.

Permissions

The session user must belong to the same customer as the sensor and must have the permission edit_sensor_config.

path Parameters
sensorId
required
string = 26 characters

ID of the sensor for which the configuration is to be retrieved

Responses

Response samples

Content type
application/json
{
  • "firmwareVersion": null,
  • "otaEnabled": true,
  • "logLevel": 1,
  • "mqttLogLevelLive": "Info",
  • "mqttLogLevelOnDemand": "Info"
}

Update firmware config

Updates the firmware configuration of a Vayyar sensor.

Permissions

The session user must belong to the same customer as the sensor and have the permission edit_sensor_config.

path Parameters
sensorId
required
string = 26 characters

ID of the sensor for which the configuration is to be updated

Request Body schema: application/json
required

The new configuration to be used.

firmwareVersion
required
integer or null <int32>
Default: null

It can be set to install a firmware version on a sensor independently of the global version.

Possible value is the versionCode of a firmware. If the firmware is deleted from the system, this value is reset to null and the global firmware version is installed.

The firmware version will be installed on the sensor the next time it is started. If null is set, the default version is installed. If a version is set that is older or the same as the version installed on the sensor, no update is performed.

otaEnabled
required
boolean
Default: true

If true, the sensor automatically checks for firmware updates at startup and installs them.

Not supported as of firmware version v0.38.

logLevel
required
integer <int32>
Default: 1
Enum: -1 0 1 2 3

Defines which messages are recorded in the sensor log.

  • -1 - Verbose
  • 0 - Debug
  • 1 - Info
  • 2 - Warn
  • 3 - Error
mqttLogLevelLive
required
string (VayyarMqttLogLevel)
Default: "Info"
Enum: "Disable" "Verbose" "Debug" "QaDebug" "Info" "Warn" "Error"

Sensor log level for immediate messages.

Immediate messages are automatically sent to the cloud during device operation.

Supported from firmware version v0.42.

mqttLogLevelOnDemand
required
string (VayyarMqttLogLevel)
Default: "Debug"
Enum: "Disable" "Verbose" "Debug" "QaDebug" "Info" "Warn" "Error"

Log level for non-immediate messages

Non-immediate messages are stored in non-volatile memory and sent to the cloud upon request or when the device is rebooted.

Supported from firmware version v0.42.

Responses

Request samples

Content type
application/json
{
  • "firmwareVersion": null,
  • "otaEnabled": true,
  • "logLevel": 1,
  • "mqttLogLevelLive": "Info",
  • "mqttLogLevelOnDemand": "Info"
}

Response samples

Content type
application/json
{
  • "firmwareVersion": null,
  • "otaEnabled": true,
  • "logLevel": 1,
  • "mqttLogLevelLive": "Info",
  • "mqttLogLevelOnDemand": "Info"
}

Get telemetry config

Returns the telemetry configuration of a Vayyar sensor. Telemetry data is required for troubleshooting and analysis and must be sent to manufacturer in case of problems.

Permissions

The session user must belong to the same customer as the sensor and must have the permission edit_sensor_config.

path Parameters
sensorId
required
string = 26 characters

ID of the sensor for which the configuration is to be retrieved

Responses

Response samples

Content type
application/json
{
  • "policy": 0,
  • "transport": 0
}

Update telemetry config

Updates the telemetry configuration of a Vayyar sensor.

Permissions

The session user must belong to the same customer as the sensor and have the permission edit_sensor_config.

path Parameters
sensorId
required
string = 26 characters

ID of the sensor for which the configuration is to be updated

Request Body schema: application/json
required

The new configuration to be used.

policy
required
integer <int32>
Default: 2
Enum: 0 1 2
  • 0 - Off: No telemetry data are sent
  • 1 - On: Telemetry data is sent constantly (not recommended)
  • 2 - On fall: Telemetry data is sent in the event of a fall (recommended)
transport
required
integer <int32>
Default: 1
Enum: 0 1 2
  • 0 - Sends the telemetry data via MQTT with QoS level 0
  • 1 - Sends the telemetry data via MQTT with QoS level 1
  • 2 - Sends the telemetry data via HTTP

Responses

Request samples

Content type
application/json
{
  • "policy": 0,
  • "transport": 0
}

Response samples

Content type
application/json
{
  • "policy": 0,
  • "transport": 0
}

Get danger config

Returns critical configuration parameters of a Vayyar sensor.

Permissions

The session user must be a system admin.

path Parameters
sensorId
required
string = 26 characters

ID of the sensor for which the configuration is to be retrieved

Responses

Response samples

Content type
application/json
{
  • "reportFallsToMqtt": true,
  • "silentModeEnabled": false,
  • "demoModeEnabled": false,
  • "fallingSensitivity": 1,
  • "fallingTrigger": 0,
  • "maxTargetsForFallingTrigger": 0,
  • "durationUntilConfirmSec": 52,
  • "energyDurationUntilConfirm": 30,
  • "confirmedToAlertTimeoutSec": 40,
  • "callingToFinishTime": 30,
  • "callingDurationSec": 30,
  • "sensitivityModeEnabled": true,
  • "sensitivityModeMinEvents": 5,
  • "sensitivityModeRequiredLoops": 4,
  • "sensitivityLevel": 78,
  • "reportPresenceToMqtt": true,
  • "targetPositionChangeThresholdCm": 20,
  • "presenceReportMinRateSec": 60,
  • "presenceReportPeriodicEnabled": true,
  • "doorEventsEnabled": true,
  • "bedExitEnabled": true,
  • "regulationZone": "WW",
  • "bandwidth": "BW500",
  • "functionType": "Falling",
  • "functionAlgorithm": "Falling",
  • "enableAnalytics": true,
  • "offlineModeEnabled": false,
  • "httpLogEnabled": true,
  • "ntpServerPrimary": "europe.pool.ntp.org",
  • "ntpServerSecondary": "us.pool.ntp.org",
  • "bedExitSuspendDuration": 900,
  • "bedExitPredictionThreshold": 90,
  • "bedExitFramesToReset": 100,
  • "bedExitSuspendTelemetryEnabled": true,
  • "fallingMitigatorThreshold": 0,
  • "heatupEnabled": true,
  • "agcEnabled": true,
  • "radarMode": 0,
  • "subscriptionExpired": false,
  • "dspRecordReportingEnabled": true,
  • "dspRecordMaxLatency": false,
  • "trackerTargetPolicy": 0,
  • "bleBeaconScannerEnabled": false,
  • "bleBeaconRssiThreshold": -80,
  • "bleBeaconMacAddr": [ ],
  • "bleServerType": "VayyarApp",
  • "bleDeviceName": "VC000",
  • "wifiRssiMonitorEnabled": false,
  • "wifiRssiMonitorThreshold": -70,
  • "wifiRssiMonitorRequiredSamples": 30,
  • "wifiHealthMonitorEnabled": true,
  • "wifiHealthMonitorRestartDuration": 240,
  • "wifiHealthMonitorBurstLimit": 15,
  • "wifiHealthMonitorMaxDisconnects": 15
}

Update danger config

Updates critical configuration parameters of a Vayyar sensor.

Permissions

The session user must be a system admin.

path Parameters
sensorId
required
string = 26 characters

ID of the sensor for which the configuration is to be updated

Request Body schema: application/json
required

The new configuration to be used.

reportFallsToMqtt
required
boolean
Default: true

Set to true so that fall messages are sent to the PureLife Cloud via MQTT.

silentModeEnabled
required
boolean
Default: false
demoModeEnabled
required
boolean
Default: false

When true is the interval between detected and confirmed and confirmed and calling is 10 seconds each. Thus, the total time until fall detection is 20 seconds. The presence report rate changed to 3 seconds.

Should not be activated in productive use, but only for customer demonstrations.

fallingSensitivity
required
integer <int32>
Default: 1
Enum: 1 2
  • 1 - Default: Detects a fall only when the person is lying flat on the floor. Less prone to False alarms
  • 2 - High: Detects a fall when the person is sitting low or lying on the floor
fallingTrigger
required
integer <int32>
Default: 0
Enum: 1 0

Not supported as of firmware version v0.34.

maxTargetsForFallingTrigger
required
integer <int32>
Default: 0

Not supported as of firmware version v0.29.

durationUntilConfirmSec
required
integer <int32>
Default: 52

Time in seconds the sensor remains in the detected state before it changes to the confirmed state.

Supported from firmware version v0.40.

energyDurationUntilConfirm
required
integer <int32>
Default: 30

Minimum time in seconds that the fallen person must remain at the fall location in order to change from "detected" to "confirmed".

The manufacturer recommends that the value corresponds to 60% of the value durationUntilConfirmSec.

Supported from firmware version v0.42.

confirmedToAlertTimeoutSec
required
integer <int32>
Default: 40

Time in seconds how long the sensor waits before reporting a fall.

A lower value can lead to false alarms, which can be cancelled by the algorithm with a larger value. It is recommended to not change this value!

Is the time the sensor remains in the "confirmed" state before it changes to the "calling" state.

callingToFinishTime
required
integer <int32>
Default: 30

Time in seconds how long the alarm lasts after a fall.

Is the time the sensor remains in the "calling" state before it changes to the "finished" state.

Not supported as of firmware version v0.38.

callingDurationSec
required
integer <int32>
Default: 30

Time in seconds how long the alarm lasts after a fall.

Is the time the sensor remains in the "calling" state before it changes to the "finished" state.

Supported from firmware version v0.38.

sensitivityModeEnabled
required
boolean
Default: true

Set to true to enable the sensor to detect falls that do not have a height transition.

Supported from firmware version v0.38.

sensitivityModeMinEvents
required
integer <int32>
Default: 5

How many consecutive detections of a person perceived on the floor need to happen in order to raise the alert.

Supported from firmware version v0.38.

sensitivityModeRequiredLoops
required
integer <int32>
Default: 4

How many of detections need to meet the sensitivityLevel, in order to raise the alert.

Supported from firmware version v0.38.

sensitivityLevel
required
integer <int32>
Default: 78

Suspected fall events with a confidence level that is above this threshold are considered human falls.

Supported from firmware version v0.38.

reportPresenceToMqtt
required
boolean
Default: true

When true, presence messages are sent to the MQTT broker.

targetPositionChangeThresholdCm
required
integer <int32>
Default: 20

Specifies how much a person must have moved for it to be detected as motion by the device. If a person moves only one centimeter, it is usually not detected as motion by the device.

Not supported as of firmware version v0.29.

presenceReportMinRateSec
required
integer <int32>
Default: 60

The interval in seconds at which presence messages are sent. These messages are in addition to the presence messages that are sent when a state change occurs.

presenceReportPeriodicEnabled
required
boolean
Default: true

If true, events are sent when presence status changes and at regular intervals. If false, events are sent only when presence status changes and without recurrence.

Supported from firmware version v0.42.

doorEventsEnabled
required
boolean
Default: true

If true, the sensor indicates a person entering/exiting the room and sends an corresponding event.

To use this function, a region must be declared as a door region.

Supported from firmware version v0.38.

bedExitEnabled
required
boolean
Default: true

If true, the sensor detects when the bed is left, sends events and triggers the dry contact.

To use this function, a region must be declared as a bed region.

The function is only activated on the sensor if this parameter is set to 'true' and there is a bed region.

Supported from firmware version v0.38.

regulationZone
required
string
Default: "WW"
Enum: "WW" "JP"

Radio frequency regulation zone. Required in Japan.

  • "WW" - Worldwide
  • "JP" - Japan

Supported from firmware version v0.42.

bandwidth
required
string
Default: "BW500"
Enum: "BW500" "BW2500"

Radio frequency transmission bandwidth in MHz.

  • "BW500" - 500 MHz
  • "BW2500" - 2500 MHz

Supported from firmware version v0.42.

functionType
required
string
Default: "Falling"
Enum: "Falling" "BedExit" "Bathroom"

This parameter defines the product type and functionality of the sensor.

Supported from firmware version v0.42.

functionAlgorithm
required
string
Default: "Falling"
Enum: "Falling" "Tracking"

Defines which algorithm profile is used.

  • "Falling" - Optimized for fall detection.
  • "Tracking - Optimized for person movement tracking.

Supported from firmware version v0.42.

enableAnalytics
required
boolean
Default: true

Analytics event should not be deactivated at this time!

offlineModeEnabled
required
boolean
Default: false

If true, the function of the device rebooting every 5 minutes after a disconnect will not take place and the device will reboot at the next scheduled reboot for OTA.

Supported from firmware version v0.38.

httpLogEnabled
required
boolean
Default: true

Log messages are stored in memory and sent to the cloud when the device is rebooted if this option is enabled.

Supported from firmware version v0.42.

ntpServerPrimary
required
string
Default: "europe.pool.ntp.org"

Hostname of the primary NTP server to fall back to after NTP with provisioned server fails.

Supported from firmware version v0.42.

ntpServerSecondary
required
string
Default: "us.pool.ntp.org"

Hostname of the secondary NTP server to fall back to after NTP with primary NTP server fails.

Supported from firmware version v0.42.

bedExitSuspendDuration
required
integer <int32>
Default: 900

Interruption duration in seconds after the bed exit event was sent.

Supported from firmware version v0.42.

bedExitPredictionThreshold
required
integer <int32>
Default: 90

The parameter is currently not used.

Supported from firmware version v0.42.

bedExitFramesToReset
required
integer <int32>
Default: 100

After the specified number of frames have occurred since a bed exit event, the big-data stream tracker resets the H and C parameters of the neural network.

Supported from firmware version v0.42.

bedExitSuspendTelemetryEnabled
required
boolean
Default: true

If true, telemetry of fall and bed exit events are sent in suspension mode. Note that this flag does not override the telemetry policy. That means, it only enables event telemetry if the telemetry policy allows it during suspend mode.

Supported from firmware version v0.42.

fallingMitigatorThreshold
required
integer <int32>
Default: 0

Threshold that sets the limit for the mitigator. If the result of the mitigator algorithm is below this threshold, the fall is mitigated and not reported.

Supported from firmware version v0.42.

heatupEnabled
required
boolean
Default: true

Brings the sensor to operating temperature when starting.

Recommended for correct operation.

Supported from firmware version v0.38.

agcEnabled
required
boolean
Default: true

Perform radar Auto-Gain-Calibration before entering monitoring mode.

Recommended for correct operation.

Supported from firmware version v0.38.

radarMode
required
integer <int32>
Default: 0
Enum: 0 1
  • 0 - Fall detection
  • 1 - Breathing detection

Supported from firmware v0.34 to v0.38.

subscriptionExpired
required
boolean
Default: false

Not supported as of firmware version v0.29.

dspRecordReportingEnabled
required
boolean

If true, the racker big-data stream is enable.

Supported from firmware version v0.38.

dspRecordMaxLatency
required
integer <int32>
Default: false

The maximum time in seconds data is stored in the big data buffer before being sent.

Supported from firmware version v0.42.

trackerTargetPolicy
required
integer <int32>
Default: 0
Enum: 0 1

If 1, the racker big-data stream is enable.

Supported from firmware v0.38 to v0.40.

bleBeaconScannerEnabled
required
boolean
Default: false

If true, the BLE beacon is active.

Supported from firmware version v0.42.

bleBeaconRssiThreshold
required
integer <int32>
Default: -80

The BLE beacon scanner ignores beacons with an RSSI below the specified value.

Supported from firmware version v0.42.

bleBeaconMacAddr
required
Array of strings
Default: []

MAC addresses of BLE beacons that are scanned for. All other BLE devices will be ignored.

Supported from firmware version v0.42.

bleServerType
required
string
Default: "VayyarApp"
Enum: "VayyarApp" "Custom1"

Controls the configuration of "operational BLE".

  • "VayyarApp" - Standard Vayyar BLE server
  • "Custom1" - Custom system server

Supported from firmware version v0.42.

bleDeviceName
required
string
Default: "VC000"

Name of the BLE server.

This information is relevant if bleServerType is set to "Custom1".

Supported from firmware version v0.42.

wifiRssiMonitorEnabled
required
boolean
Default: false

If true, the sensor attempts to reconnect to an AP with a better RSSI if the RSSI of the current AP is below the specified threshold.

This feature is called "WiFi RSSI Monitor".

Supported from firmware version v0.42.

wifiRssiMonitorThreshold
required
integer <int32>
Default: -70

Threshold is the average RSSI value that the WiFi RSSI Monitor monitors to trigger disconnection from the AP and attempt to connect to an AP with a better RSSI.

Supported from firmware version v0.42.

wifiRssiMonitorRequiredSamples
required
integer <int32>
Default: 30

Number of RSSI samples required by the WiFi RSSI monitor to trigger disconnection.

Supported from firmware version v0.42.

wifiHealthMonitorEnabled
required
boolean

If true, the sensors activates the "Wifi health monitor".

The monitor checks Wi-Fi health based on the following parameters:

  1. Loss of connection for the defined time.
  2. Frequency of disconnections.

If one of the conditions is met, the Wi-Fi adapter is restarted.

Supported from firmware version v0.42.

wifiHealthMonitorRestartDuration
required
integer <int32>
Default: 240

Maximum time in seconds of interruption in seconds that triggers a WiFi restart

Supported from firmware version v0.42.

wifiHealthMonitorBurstLimit
required
integer <int32>
Default: 15

If the burst count exceeds this value, WiFi Monitor will search for another access point.

Supported from firmware version v0.42.

wifiHealthMonitorMaxDisconnects
required
integer <int32>
Default: 15

Wifi health monitor maximum (average) disconnections per hour if the number of disconnections per hour is above this value, the wifi monitor shall look for another AP

Supported from firmware version v0.42.

Responses

Request samples

Content type
application/json
{
  • "reportFallsToMqtt": true,
  • "silentModeEnabled": false,
  • "demoModeEnabled": false,
  • "fallingSensitivity": 1,
  • "fallingTrigger": 0,
  • "maxTargetsForFallingTrigger": 0,
  • "durationUntilConfirmSec": 52,
  • "energyDurationUntilConfirm": 30,
  • "confirmedToAlertTimeoutSec": 40,
  • "callingToFinishTime": 30,
  • "callingDurationSec": 30,
  • "sensitivityModeEnabled": true,
  • "sensitivityModeMinEvents": 5,
  • "sensitivityModeRequiredLoops": 4,
  • "sensitivityLevel": 78,
  • "reportPresenceToMqtt": true,
  • "targetPositionChangeThresholdCm": 20,
  • "presenceReportMinRateSec": 60,
  • "presenceReportPeriodicEnabled": true,
  • "doorEventsEnabled": true,
  • "bedExitEnabled": true,
  • "regulationZone": "WW",
  • "bandwidth": "BW500",
  • "functionType": "Falling",
  • "functionAlgorithm": "Falling",
  • "enableAnalytics": true,
  • "offlineModeEnabled": false,
  • "httpLogEnabled": true,
  • "ntpServerPrimary": "europe.pool.ntp.org",
  • "ntpServerSecondary": "us.pool.ntp.org",
  • "bedExitSuspendDuration": 900,
  • "bedExitPredictionThreshold": 90,
  • "bedExitFramesToReset": 100,
  • "bedExitSuspendTelemetryEnabled": true,
  • "fallingMitigatorThreshold": 0,
  • "heatupEnabled": true,
  • "agcEnabled": true,
  • "radarMode": 0,
  • "subscriptionExpired": false,
  • "dspRecordReportingEnabled": true,
  • "dspRecordMaxLatency": false,
  • "trackerTargetPolicy": 0,
  • "bleBeaconScannerEnabled": false,
  • "bleBeaconRssiThreshold": -80,
  • "bleBeaconMacAddr": [ ],
  • "bleServerType": "VayyarApp",
  • "bleDeviceName": "VC000",
  • "wifiRssiMonitorEnabled": false,
  • "wifiRssiMonitorThreshold": -70,
  • "wifiRssiMonitorRequiredSamples": 30,
  • "wifiHealthMonitorEnabled": true,
  • "wifiHealthMonitorRestartDuration": 240,
  • "wifiHealthMonitorBurstLimit": 15,
  • "wifiHealthMonitorMaxDisconnects": 15
}

Response samples

Content type
application/json
{
  • "reportFallsToMqtt": true,
  • "silentModeEnabled": false,
  • "demoModeEnabled": false,
  • "fallingSensitivity": 1,
  • "fallingTrigger": 0,
  • "maxTargetsForFallingTrigger": 0,
  • "durationUntilConfirmSec": 52,
  • "energyDurationUntilConfirm": 30,
  • "confirmedToAlertTimeoutSec": 40,
  • "callingToFinishTime": 30,
  • "callingDurationSec": 30,
  • "sensitivityModeEnabled": true,
  • "sensitivityModeMinEvents": 5,
  • "sensitivityModeRequiredLoops": 4,
  • "sensitivityLevel": 78,
  • "reportPresenceToMqtt": true,
  • "targetPositionChangeThresholdCm": 20,
  • "presenceReportMinRateSec": 60,
  • "presenceReportPeriodicEnabled": true,
  • "doorEventsEnabled": true,
  • "bedExitEnabled": true,
  • "regulationZone": "WW",
  • "bandwidth": "BW500",
  • "functionType": "Falling",
  • "functionAlgorithm": "Falling",
  • "enableAnalytics": true,
  • "offlineModeEnabled": false,
  • "httpLogEnabled": true,
  • "ntpServerPrimary": "europe.pool.ntp.org",
  • "ntpServerSecondary": "us.pool.ntp.org",
  • "bedExitSuspendDuration": 900,
  • "bedExitPredictionThreshold": 90,
  • "bedExitFramesToReset": 100,
  • "bedExitSuspendTelemetryEnabled": true,
  • "fallingMitigatorThreshold": 0,
  • "heatupEnabled": true,
  • "agcEnabled": true,
  • "radarMode": 0,
  • "subscriptionExpired": false,
  • "dspRecordReportingEnabled": true,
  • "dspRecordMaxLatency": false,
  • "trackerTargetPolicy": 0,
  • "bleBeaconScannerEnabled": false,
  • "bleBeaconRssiThreshold": -80,
  • "bleBeaconMacAddr": [ ],
  • "bleServerType": "VayyarApp",
  • "bleDeviceName": "VC000",
  • "wifiRssiMonitorEnabled": false,
  • "wifiRssiMonitorThreshold": -70,
  • "wifiRssiMonitorRequiredSamples": 30,
  • "wifiHealthMonitorEnabled": true,
  • "wifiHealthMonitorRestartDuration": 240,
  • "wifiHealthMonitorBurstLimit": 15,
  • "wifiHealthMonitorMaxDisconnects": 15
}

sensors nova-c

Endpoints for retrieving and updating data, especially for NOVA-C sensors.

These end points are only available if the parameter manufacturer of the sensor has the value qinglan.

Get basic config

Returns the basic configuration of a Nova-C sensor.

Permissions

The session user must belong to the same customer as the sensor and have the permission manage_sensors.

path Parameters
sensorId
required
string = 12 characters

ID of the sensor for which the configuration is to be updated

Request Body schema: application/json
Schema not provided

Responses

Response samples

Content type
application/json
{
  • "name": "Living room",
  • "workingMode": 15
}

Update basic config

Updates the basic configuration of a Nova-C sensor.

Permissions

The session user must belong to the same customer as the sensor and have the permission manage_sensors.

path Parameters
sensorId
required
string = 12 characters

ID of the sensor for which the configuration is to be retrieved

Request Body schema: application/json
required

The new configuration to be used.

name
required
string [ 3 .. 64 ] characters
workingMode
required
integer <int32>
Default: 15
Enum: 3 7 11 15
  • 3 - Presence
  • 7 - Fall detection
  • 11 - Sleep
  • 15 - Full

Responses

Request samples

Content type
application/json
{
  • "name": "Living room",
  • "workingMode": 15
}

Response samples

Content type
application/json
{
  • "name": "Living room",
  • "volume": 0,
  • "ledMode": 0,
  • "learningModeEnabled": false,
  • "learningModeEndDate": null,
  • "testModeEnabled": false,
  • "fallingMitigatorEnabled": true,
  • "optimizationEnabled": true
}

Get fall config

Returns the fall configuration of a Nova-C sensor.

Permissions

The session user must belong to the same customer as the sensor and have the permission manage_sensors.

path Parameters
sensorId
required
string = 12 characters

ID of the sensor for which the configuration is to be updated

Request Body schema: application/json
Schema not provided

Responses

Response samples

Content type
application/json
{
  • "alarmTime": 60,
  • "sittingAlarmEnabled": false,
  • "sittingUpAlarmEnabled": false,
  • "postureDetectionEnabled": true,
  • "sitDownAlarmTime": 60
}

Update fall config

Updates the fall configuration of a Nova-C sensor.

Permissions

The session user must belong to the same customer as the sensor and have the permission manage_sensors.

path Parameters
sensorId
required
string = 12 characters

ID of the sensor for which the configuration is to be retrieved

Request Body schema: application/json
required

The new configuration to be used.

alarmTime
required
integer <int32> [ 0 .. 250 ]
Default: 60
sittingAlarmEnabled
required
boolean
Default: false
sittingUpAlarmEnabled
required
boolean
Default: false
postureDetectionEnabled
required
boolean
Default: true
sitDownAlarmTime
required
integer <int32> [ 0 .. 100 ]
Default: 60

Responses

Request samples

Content type
application/json
{
  • "alarmTime": 60,
  • "sittingAlarmEnabled": false,
  • "sittingUpAlarmEnabled": false,
  • "postureDetectionEnabled": true,
  • "sitDownAlarmTime": 60
}

Response samples

Content type
application/json
{
  • "alarmTime": 60,
  • "sittingAlarmEnabled": false,
  • "sittingUpAlarmEnabled": false,
  • "postureDetectionEnabled": true,
  • "sitDownAlarmTime": 60
}

Get vital data config

Returns the vital data configuration of a Nova-C sensor.

Permissions

The session user must belong to the same customer as the sensor and have the permission manage_sensors.

path Parameters
sensorId
required
string = 12 characters

ID of the sensor for which the configuration is to be updated

Request Body schema: application/json
Schema not provided

Responses

Response samples

Content type
application/json
{
  • "respirationRateUpper": 20,
  • "respirationRateLower": 10,
  • "heartRateUpper": 80,
  • "heartRateLower": 60,
  • "continuousDetectionEnabled": false,
  • "weakVitalSignThresholdMinutes": 10,
  • "weakVitalSignSensitivity": 5
}

Update vital data Config

Updates the vital data configuration of a Nova-C sensor.

Permissions

The session user must belong to the same customer as the sensor and have the permission manage_sensors.

path Parameters
sensorId
required
string = 12 characters

ID of the sensor for which the configuration is to be retrieved

Request Body schema: application/json
required

The new configuration to be used.

respirationRateUpper
required
integer <int32> [ 10 .. 100 ]
Default: 20
respirationRateLower
required
integer <int32> [ 1 .. 20 ]
Default: 10
heartRateUpper
required
integer <int32> [ 10 .. 255 ]
Default: 80
heartRateLower
required
integer <int32> [ 1 .. 100 ]
Default: 60
continuousDetectionEnabled
required
boolean
Default: false
weakVitalSignThresholdMinutes
required
integer <int32> [ 1 .. 15 ]
Default: 10
weakVitalSignSensitivity
required
integer <int32> [ 1 .. 99 ]
Default: 5

Responses

Request samples

Content type
application/json
{
  • "respirationRateUpper": 20,
  • "respirationRateLower": 10,
  • "heartRateUpper": 80,
  • "heartRateLower": 60,
  • "continuousDetectionEnabled": false,
  • "weakVitalSignThresholdMinutes": 10,
  • "weakVitalSignSensitivity": 5
}

Response samples

Content type
application/json
{
  • "name": "Living room",
  • "volume": 0,
  • "ledMode": 0,
  • "learningModeEnabled": false,
  • "learningModeEndDate": null,
  • "testModeEnabled": false,
  • "fallingMitigatorEnabled": true,
  • "optimizationEnabled": true
}

firmwares

Endpoints for getting and updating sensor firmwares.

Get all firmwares

Return a list of software available for this PureLife Cloud.

Permissions

The session user must have the permission edit_sensor_config.

Responses

Response samples

Content type
application/json
[
  • {
    • "versionCode": 40017,
    • "versionName": "v0.40.17",
    • "createDate": 1659698159000,
    • "name": "vayyar-care-0xcb34e0d4-walabot-home-v0.40.17",
    • "isDefault": true
    }
]