Download as PDF

 

Technical Documentation

Version 0.1

13th May 2022

The contents of this documentation changes regularly and certain parts may already be outdated upon publication.

Please contact your local NIVY Partner for the latest documentation.


Technical Documentation

Hardware

NIVY Watch

Introduction

Physical Overview

Powering on NIVY Watch

Charging the NIVY Watch

Strap Removal & Replacement

Cleaning & Maintenance

Single Charging Station

Multi Charging Station (MCS)

Quad Charging Station

Beacons

Installation

Powering On/Off

Battery Replacement

Best Practise

For Square Rooms

For Rectangle Rooms

For Triangular Rooms

Tips

NIVY Watch OS

Watch Face

Launcher

Register Device

Unregister Device

Updates

Service Menu

Connect to Wi-Fi

Manual Updates

Power Menu

Messaging

Activities

Using ADB

Installing Applications using ADB

Uninstalling Applications using ADB

List Installed Packages using ADB

NIVY Data Factory

Analytics

Messaging

Overview

Sending a Message

Replying to a Message

Predefined Message Configuration

Predefined Response Configuration

Watch Settings

Overview

Configuration

Activities

Edit Task Activities

Edit Application Activities

Beacon Configuration

Areas

Power BI

API

Available APIs

Obtaining A Token

GET Token

Data Service

Methods

GET api/ConfigBeacons

GET api/ConfigBeacons/{id}

GET api/ConfigAreas

GET api/ConfigAreas/{id}

GET api/Settings

GET api/Settings/{id}

GET api/MessageResponseType

GET api/MessageResponseType/{id}

GET api/MessageBox?toId={toId}

GET api/MessageBox/{id}

POST api/MessageBox

GET api/ConfigWatchGroup

GET api/ConfigWatchGroup/{id}

GET api/MessageResponseValue?responseType={responseType}

GET api/MessageResponseValue/{id}

GET api/ConfigWatches

GET api/ConfigWatches/{id}

GET api/ConfigWatches?serialNr={serialNr}

GET api/ConfigActivities

GET api/ConfigActivities/{id}

Troubleshooting

NIVY Watch

Glossary

Hardware

NIVY Watch

Introduction

The NIVY Watch is an Android Based Hardware that is easily worn on the wrist and used for data collection and communication.

Our focus on ergonomic design resulted in a watch that is comfortable to wear and functional through the most challenging work situations. A single button located at the bottom of the screen, always facing the user, is easily operated even whilst wearing heavy-duty gloves. The unique symmetric design of the watch body allows the user to wear the NIVY Watch on the wrist of either hand with the same ease of use.

Physical Overview

Powering on NIVY Watch

Press and hold the power button for 2-3 seconds. You will see the NIVY Banner and then a short animation.

Charging the NIVY Watch

Place the watch on an approved NIVY Charging Station or dock. If the device is off, you will see a battery animation confirming charging. If the device is powered on, a green watch face will be displayed with information regarding the current charge level.

Strap Removal & Replacement

The strap can easily be removed or replaced by inserting a flat head screwdriver between the strap and the watch. You may need to apply gentle pressure to the spring and the strap will release.

Cleaning & Maintenance

Although NIVY Watch requires minimal maintenance, with extended use the screen & heart rate sensor may become contaminated. These can be cleaned using an off-the-shelf screen cleaner and microfibre cloth or a damp cloth. It is advised not to use any chemical cleaners to prevent damage to the charging contacts or skin irritation of the wearer.

Technical Specification

 

Appearance

Form Factor

Smart Watch with round Display

Body Colour

Black

Parameters

Platform

MT6739 (1.3GHz Quad core cotex-A7)

Display

1.39” Amoled Resolution 400*400

OS

Android 7.1

Display Glass

Corning Gorilla Glass 4

TP

Capacitive Touch Screen

Memory

3 + 32GB

Bluetooth

Bluetooth 4.0

WiFi

2,4 Ghz

Sensors

3-axis G-sensor, Optical Heart Rate Sensor

Receiver

Included

Vibration

Included

Battery

3-axis G-sensor, Optical Heart Rate Sensor

Standby Time

Approx. 100 Hours

Charger

Single Charging Station USB Cable

IP Rating

IP54

Removable Strap

Included

Language

English

Single Charging Station

The Developer Dock is clearly identified due to having only a single position for docking a device and having 4 pins, 2 of which are power and 2 are data.

Developer docks enable the device to communicate with a computer for different activities such as installing and removing applications via ADB (See ‘NIVY Watch OS > Installing Applications using ADB’)

Multi Charging Station (MCS)

The NIVY Multi Charging Station (MCS) enables as many as 60 devices to be charged per bay. These bays can be either mounted to a wall or placed on a flat, stable surface.

We have several sizes of MCS. 18pos, 30pos and 60pos. The system modularity allows extendability at a later time.

The MCS requires a standard power outlet. It is compatible with both a 110V and 230V outlet.

Quad Charging Station

Quad chargers can charge 4 devices from a single power source. They are useful for smaller deployments or developers.

Beacons

Installation

Using Adhesive Plate

  1. Find a surface and location that has a good line of sight to where the devices will be used
  2. Ensure the surface is clean
  3. Remove the cover from the self-adhesive sticker and install the plate
  4. Clip the beacon on using the internal magnet

Using Internal Magnet

  1. Find a magnetic surface and location that has a good line of sight to where the devices will be used
  2. Remove the Adhesive plate if installed
  3. Place the beacon onto the magnetic surface

Powering On/Off

All beacons are delivered with the power off, the power button is located inside the beacon.

  1. Remove the back cover by twisting anti-clockwise
  2. Insert a pen or thin object inside to press and hold the button
  3. The devices LED on the front of the beacon will now flash

 

1 Long Flash

Powered On

3 Short Flashes

Powered Off

Battery Replacement

NIVY Beacons use 2x Primary Lithium 3.6v ½ AA Batteries which last approximately 7 years. Replacement is possible at the users own risk, but it may not be a cost-effective option compared to Beacon replacement. Contact your local NIVY Distributor for more information.

Replacement is simple

  1. Open the Beacon by turning the cover anti-clockwise
  2. Remove the old batteries
  3. Insert new batteries
  4. Power the Beacon on (See ‘Hardware > Beacons > Powering On/Off’)

Best Practise

For Square Rooms

For normal situations, a single beacon placed in the middle of the room will provide sufficient coverage.

For increased accuracy or for larger rooms, more beacons can be placed overlapping one another

For Rectangle Rooms

For normal situations, beacons placed 15 metres apart placed in the centre of the  room will provide sufficient coverage.

For increased accuracy or for larger rooms, more beacons can be placed overlapping one another

For Triangular Rooms

For normal situations, a single beacon placed in the middle of the room will provide sufficient coverage.

For increased accuracy or for larger rooms, more beacons can be placed overlapping one another

Tips
  • Placed as high as possible to give the maximum line of sight
  • Not to be placed in enclosed areas such as cupboards or inside machinery
  • Out of reach of customers and employees
  • Location of beacons should be stored on a floor plan and kept with the system administrator – if possible, also share this with your partner or NIVY account manager
  • Remember, beacons do not need to be within Wi-Fi coverage
  • Beacons cover a circular area from where they are placed, this should be considered when designing an area of various shapes

NIVY Watch OS

Watch Face

Launcher

Preinstalled with NIVY OS is the NIVY Launcher. The NIVY Launcher displays the watch face and offers a simple, distraction free menu to launch applications and select activities.

The NIVY Launcher

Register Device

Upon initiating the device for the first time, it will need to be registered to an organisation.

  1. Once powering on the device, you will be greeted with a registration screen. Here, you can configure Wi-Fi if not already done so. Once you are connected to the Internet, tap the long number at the top – this is the device IMEI number
  2. Now, enter the PIN provided by your administrator (Default: 1111)
  3. Once the device is registered, you will see the NIVY Home Screen

Unregister Device

It may be necessary to unregister a device.

  1. Open the ‘Service Menu’ (See ‘NIVY Watch OS > Service Menu’)
  2. Scroll down and tap ‘Unregister’
  3. Tap ‘Yes’ to confirm

Updates

NIVY Watch OS is designed in a way that firmware & security updates take place in the background without user input. This is to ensure the device is always up-to-date and secure.

Manual updates can be initiated via ‘Service Menu > Update’ (See ‘NIVY Watch OS > Service Menu’)

Service Menu

The service menu is hidden but can easily be accessed by

  1. Double tapping to open the main menu
  2. Select ‘Main Menu’
  3. Select ‘Info’
  4. Double Tap ‘Info’ at the top of the screen

Connect to Wi-Fi

To start collecting and analysing data and to manage your NIVY Watch remotely through NIVY Data Factory you need to connect it to the internet. For production deployments this would be done remotely at the factory or through a Multi Charging Station with a built in connectivity. For use with the Starter Kit you must set up the Wireless LAN connection manually:

  1. Go to the WiFi submenu in the Service Menu, select your network from the list of nearby networks and fill out the credentials.
  2. The setup process is the same on any other Android device.
  3. To exit the WiFi setup, swipe from left-to-right on the touch screen.

Manual Updates

To force the check for updates manually, use the Update submenu of the Service menu and follow the on-screen instructions.

Power Menu

NIVY Watch has a simple power menu with several options, the power menu can be accessed by pressing and holding the main button for approximately 2 seconds.

 

Number

Name

Description

1

Screen Ratio

Can change the display from circular to square. Useful for non-optimized applications running on the device

2

Power Save

A defunct functionality used to put the watch in a hibernation mode

3

Recent Tasks

Opens the typical Android Recent Tasks where you can see running applications, switch between them or close them

4

Reboot

Soft restart of the device

5

Power Off

Power off the device

Messaging

  1. Double Tap the NIVY Launcher Home Screen
  2. Select ‘New Message’
  3. Select ‘Manager’ or ‘Employee’
  4. Employee: Select the Employee
  5. Select the predefined message
  6. Confirm

Activities

Activities are defined in the Data Factory (See ‘NIVY Data Factory > Activities’. It provides a way for the user to choose an activity from the pre-defined list. This can later be used in analytics (See ‘Data Factory > Analytics’)

Using ADB

Installing Applications using ADB

Applications can be installed on devices with developer mode privileges (See ‘NIVY Data Factory > Watch Configuration’).

Prerequisites

  • Computer running Windows, Linux, or Mac
  • ADB Installed
  • Developer Privileges on the NIVY Watch (See ‘NIVY Data Factory > Watch Configuration’)
  • Developer Dock
  • APK of Application to be installed

Installing an Application

  1. Open a terminal prompt
  2. Type ‘ADB Devices’ – The device should appear on the screen. Make sure to check the NIVY Watch, as you may need to authorise the computer.

  1. Type ‘ADB install <PATH TO APK>’ – you should receive a success prompt after a few seconds
  2. If you wish for the application to be manually launched, it needs to be added to ‘Activities’ via the NIVY Data Factory (See ‘NIVY Data Factory > Activities > Applications’)

Uninstalling Applications using ADB

Applications can also be uninstalled on devices with developer mode privileges (See ‘NIVY Data Factory > Watch Configuration’).

Prerequisites

Uninstalling an Application

  1. Open a terminal prompt
  2. Type ‘ADB Devices’ – The device should appear on the screen. Make sure to check the NIVY Watch, as you may need to authorise the computer.

  1. Type ‘ADB uninstall <PACKAGE NAME>’ – You should then receive a success message.

List Installed Packages using ADB

  1. Open a terminal prompt
  2. Type ‘adb shell pm list packages’ – This will list all installed packages

NIVY Data Factory

Analytics

NIVY offers a range of built-in analytical tools using Power BI Dashboards

Below are some examples of analytical screens as of May 2022, subject to change:

Total Steps for Selected Watches by Day

Total Steps for Time Range for Selected Devices

The Distance of Other Devices from the Selected Device

Time Spent in a Selected Area by Selected Watch

Time Spent in Area by Selected Devices

Beacon Overview

Battery Level and Charging Status – Green for Charging, Red for Discharging

Messaging

The NIVY Messaging System can be accessed by selecting ‘Messages’ under the ‘WORKSPACE’ heading.

Overview

Sending a Message

  1. Log into the NIVY Data Factory
  2. Open Messages by selecting ‘Messages’ under the ‘WORKSPACE’ heading
  3. Select the device you wish to send a message to
  4. Type or select a predefined template
  5. Select the response type, and press send
  6. Once a reply has been received, it will be displayed below the message

Replying to a Message

  1. Log into the NIVY Data Factory
  2. Open Messages by selecting ‘Messages’ under the ‘WORKSPACE’ heading
  3. Select the highlighted device
  4. You will see the message with a predefined response option below, here you can select the relevant response
            

Predefined Message Configuration

  1. Log into the NIVY Data Factory
  2. Open Messages by selecting ‘Messages’ under the ‘WORKSPACE’ heading
  3. Select ‘Settings’ in the top right
  4. Select ‘Define’ under ‘Predefined Messages’
  5. To Create a new template click ‘New Template’ to edit an existing, click ‘edit’ or to delete a message click ‘delete’
  6. New Template: Enter the Sort Number, the Message Text and what should be the default response type, then press Create
  7. New Template: When you have returned to the previous screen, you can make further adjustments by clicking ‘Edit’

Predefined Response Configuration

  1. Log into the NIVY Data Factory
  2. Open Messages by selecting ‘Messages’ under the ‘WORKSPACE’ heading
  3. Select ‘Settings’ in the top right
  4. Select ‘Define’ under ‘Response Type’
  5. To Create a new response type click ‘Create New’ to edit an existing, click ‘edit’ or to delete a message click ‘delete’. You can also edit the values within a response type by clicking ‘values’
  6. Values: After clicking ‘values’, you can see the options that will be displayed on a device when the message is sent. You can create a new option by clicking ‘Define New’ or edit or delete an existing option using the relevant buttons

Watch Settings

Overview

The advanced settings menu can be accessed after logging into the NIVY Data Factory on the left hand side under ‘Watches’

 

Name

Category

Values

Default Value

Description

Update Folder

General

Update_Beta

FTP folder

User management

General

Off

On/Off (in development)

Biometrics

General

Off

On

values

on

This option defines what Biometric data the NIVY Watch collects.

  • Off – Collects no Biometric Data
  • On – Collects only a boolean value – i.e. is a heart rate detected or not
  • values – Collects the exact heart rate values

Beacon zone

General

2-15

10

If a watch is within this range (metres) it will report that it is within the beacon zone

Brightness Normal

General

0 – 100

100

Brightness of display during normal usage in %

Brightness Charge

General

0 – 100

20

Brightness of display during charging in %

Sync interval

General

60 – Inf.

3600

Time in seconds between full synchronisations. This is where data and configuration settings are synchronised between the data factory and NIVY Watch

Beacon scan

General

15 – 600

60

Time in seconds when the NIVY Watch will scan for surrounding beacons in seconds

Distancing far zone

General

2 – 15

5

The maximum distance in metres where another NIVY Device will be recognised as within range

Distancing near zone

General

1-10

3

The minimum distance in metres where another NIVY Device will be recognised as within range

Show distance

General

On

Show the distance from the nearest beacon and the length of time the device has been within range f that beacon

Brightness Sleep

General

0 – 100

0

Brightness of display in sleep mode in %

Sync Messages

General

5 – 6000

15

Time in seconds that NIVY Watch will synchronise messages with the Data Factory

Tilt detector

Sensor

0

Scanning Interval in seconds

Accelerometer

Sensor

10

Scanning Interval in seconds

Battery

Sensor

600

Scanning Interval in seconds

Heart rate

Sensor

120

Scanning Interval in seconds

Step counter

Sensor

10

Scanning Interval in seconds

Configuration

General watch configuration is found under the ‘WATCHES’ heading labelled ‘Configuration’

Here, you can configure basic watch settings –

 

Name

Default Value

Description

Name

The friendly name for the NIVY Device

Serial No.

IMEI

The unique IMEI number for the device

Watch Face

Digital

Configuration for the watch face which will appear on the device

Always Time

False

If the time is to always be displayed on the watch face

Developer Mode

False

Enable developer access to the device

Screen on Raising

False

Upon raising the watch to a horizontal position, the screen will turn on

Last Synchronisation

The last time the device completed a full synchronisation with the NIVY Data Factory

Activities

Activities are a list of options available on the NIVY Launcher. Activities can be defined by the admin so the user can choose the relevant option.

There are 2 types of Activities

  1. Task activities such as ‘call’ or ‘meeting’ – This sends the relevant record to the data factory for analysis purposes
  2. Application activities are installed applications that the user can access

Edit Task Activities

  1. Log into the NIVY Data Factory
  2. Open Activities by selecting ‘Activities’ under the ‘WATCHES’ heading
  3. Here, you can define a new activities and edit or delete an existing activity
  4. New Activity: Enter a friendly name and the sort order

 

Field

Description

Name

The friendly name for the Activity

Action

Unused for Activities

Sorting

The order in which the activity will be displayed

Edit Application Activities

  1. Log into the NIVY Data Factory
  2. Open Activities by selecting ‘Activities’ under the ‘WATCHES’ heading
  3. Here, you can define a new application and edit or delete an existing application
  4. New Application: Click ‘Define New’
  5. New Application: Enter a friendly name, the package name and the sort order

 

Field

Description

Name

The friendly name for the Application

Action

The package name of the application
This can be found by using a simple ADB to see installed packages on the device – ‘adb shell pm list packages’ – See ‘
NIVY Watch OS > Using ADB > List Installed Packages using ADB

Sorting

The order in which the application will be displayed

  1. New Application: Click ‘Create’

Beacon Configuration

  1. Log into the NIVY Data Factory
  2. Open Activities by selecting ‘Configuration’ under the ‘BEACONS’ heading
  3. Here, you can define a new beacon and edit or delete an existing beacon
  4. New Beacon: Click ‘Create New’
  5. New Beacon: Enter a friendly name, MAC address, select an area and define a range

 

Field

Description

Name

The friendly name for the Beacon

MAC Address

The MAC Address of the beacon. Located on the top of your NIVY Beacon

Area

What area your beacon will belong to (See ‘NIVY Data Factory > Areas’)

Zone (m)

The circular area in which a device will recognise itself as being inside the beacons zone – in metres

Areas

  1. Log into the NIVY Data Factory
  2. Open Areas by selecting ‘Areas’ under the ‘BEACONS’ heading
  3. Here, you can define a new area or delete an existing area
  4. New Area: Click ‘Create New’
  5. New Area: Enter a name for the area

 

Field

Description

Name

The name for the Area

Power BI

Client integration will be available in Q3 2022

API

Available APIs

 

ConfigBeacons

API

Description

ConfigBeacons

GET api/ConfigBeacons

Returns list of configured Beacons

GET api/ConfigBeacons/{id}

Returns the value of one beacon by ID

ConfigAreas

GET api/ConfigAreas

Returns list of configured Areas

GET api/ConfigAreas/{id}

Returns the value of one Area by ID

Settings

GET api/Settings

Returns list of settings

GET api/Settings/{id}

Returns the value of one setting by ID

MessageResponseType

GET api/MessageResponseType

Returns list of available response types

GET api/MessageResponseType/{id}

Returns the value of one response type by ID

MessageBox

GET api/MessageBox?toId={toId}

Returns list of messages using the watch ID

GET api/MessageBox/{id}

Returns Message using message ID

POST api/MessageBox

Generate a New Message

ConfigWatchGroup

GET api/ConfigWatchGroup

Returns list of available Watch Groups – Reserved for future functionality

GET api/ConfigWatchGroup/{id}

Returns the value of one Watch Group by ID – Reserved for future functionality

MessageResponseValue

GET api/MessageResponseValue?responseType={responseType}

List Possible Responses from MessageResponseTypes

GET api/MessageResponseValue/{id}

List details of one Possible Response type

ConfigWatches

GET api/ConfigWatches

Returns list of Watches and their configuration

GET api/ConfigWatches/{id}

Returns the configuration of one watch by ID

GET api/ConfigWatches?serialNr={serialNr}

Returns the configuration of one watch by Serial Number

ConfigActivities

GET api/ConfigActivities

Returns list of Activities

GET api/ConfigActivities/{id}

Returns a single Activity by ID

Obtaining A Token

A token is required for any interaction with the NIVY API.

GET Token

Sample URL: https://datafactory.nivy.watch/token

Body Parameters:

 

Name

Description

Type

Required

grant_type

password

string

Yes

username

Enter Username

string

Yes

password

Enter Password

string

Yes

Response

 

{
“access_token”: “NCdmKW3hlrBWAvdkQcmXSWZR4WW360u6yl7nY6vQ_ZY0-DxC4zbUPFREnz_qrk5s0suxQPHG5y90l_JaCUE2gdU6zS4jAKyLc7wME0UFv54mmM1kuCCrT5OzrsjwiYnDBThOeAdUJUvihGStEn8XXjIwK1LzEIXKaGdCXBG_QC8NEbkcJwY6UaRSJ2jRoWgt0RxhzPnW98kF8ihjXWlzD-3f-Xlm42EeA0fJm1taRrYSRoEOmZOnjlYm9EdzZP7LHnso1fKOWSpHHcMxH-1XZ-3GI6uiKgAStALRjUOz6xjbmI38YQNiY_nZ-iTRcD3AyhwhidjeuHztyzlKCx-NMxL28hzcG4OaDtrX9YSv44Y4suTMkeikEUT-hZoewFus9CMHF9Sberhvn0fP8eXKgeueYiglZLPKoT5XECK7iZ8RYhkA9ksXg_f_o-PbcGjZTr6m4-PT7spoy_x3s5nAy05l36XrlVPsQSdJlLVmse-bfbjwQXJ27keid9fYn62-pxiR8HH0a436X5xGrjRymZy-1tlkOFkuxCe3wsHkLMBn8djekWIa8zRmaFNL_Mn1231sRQ_9AlWnPuftiSv8x_crOo0dXjGHo-8HV08d1gHw”,
“token_type”: “bearer”,
“expires_in”: 7775999,
“userName”: “dale.kirkwood@nivy.watch”,
“.issued”: “Thu, 12 May 2022 11:05:26 GMT”,
“.expires”: “Wed, 10 Aug 2022 11:05:26 GMT”
}

Data Service

Methods

GET api/ConfigBeacons

A list of all Beacons that are configured on the organisation

Sample URL: https://datafactory.nivy.watch/api/ConfigBeacons

Response:

 

   {
“Id”: “8c977874-3b93-4a39-aa36-2d3c2902b1e0”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “NIVY Coffee Machine”,
“Mac”: “AC:23:3F:81:52:C5”,
“Area”: “2da42d9b-d4d3-4b19-95f4-2503e95027a7”,
“AreaName”: “NIVY Kitchen”,
“Zone”: 5
},
{
“Id”: “d55ad95e-e667-40d3-a77b-10b23b9c0fc7”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “NIVY Development”,
“Mac”: “AC:23:3F:81:52:BB”,
“Area”: “91f930b5-639c-4ca1-96bd-7499a7400c94”,
“AreaName”: “NIVY Development”,
“Zone”: 8
},
{
“Id”: “fad90d68-aa47-4799-bda6-b6c4025ec12e”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “NIVY Kitchen entrance”,
“Mac”: “AC:23:3F:81:52:BD”,
“Area”: “e01a4df3-d3c4-4e9b-877b-eb7a8ba61500”,
“AreaName”: “NIVY Reception”,
“Zone”: 5
},
{
“Id”: “00b22c7e-be4b-4a8b-ad21-687572d6e0e7”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “NIVY MCS”,
“Mac”: “AC:23:3F:81:52:C9”,
“Area”: “91f930b5-639c-4ca1-96bd-7499a7400c94”,
“AreaName”: “NIVY Development”,
“Zone”: 8
}

GET api/ConfigBeacons/{id}

List beacon information based on the beacon ID

Sample URL: https://datafactory.nivy.watch/api/ConfigBeacons/{id}

Body Parameters:

 

Name

Description

Type

Required

id

The ID of a single Beacons

Globally unique identifier

Yes

Response:

 

{
“Id”: “8c977874-3b93-4a39-aa36-2d3c2902b1e0”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “NIVY Coffee Machine”,
“Mac”: “AC:23:3F:81:52:C5”,
“Area”: “2da42d9b-d4d3-4b19-95f4-2503e95027a7”,
“AreaName”: null,
“Zone”: 5
}

GET api/ConfigAreas

A list of all pre-configured Areas – not to be confused with Beacons.  They can easily be configured from the GUI of the NIVY Data Factory (See ‘NIVY Data Factory > Areas’)

Sample URL: https://datafactory.nivy.watch/api/ConfigAreas

Response:

 

   {
“Id”: “2da42d9b-d4d3-4b19-95f4-2503e95027a7”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “NIVY Kitchen”
},
{
“Id”: “51923b99-d5ee-4f3a-9f95-c00ab8c9db77”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “NIVY Meeting room”
},
{
“Id”: “e01a4df3-d3c4-4e9b-877b-eb7a8ba61500”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “NIVY Reception”
}

GET api/ConfigAreas/{id}

List Area information based on the beacon ID

Sample URL: https://datafactory.nivy.watch/api/ConfigAreas/{id}

Body Parameters:

 

Name

Description

Type

Required

id

The ID of a single Area

Globally unique identifier

Yes

Response:

 

{
“Id”: “2da42d9b-d4d3-4b19-95f4-2503e95027a7”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “NIVY Kitchen”
}

GET api/Settings

A list of all Data Factory Watch Settings and their corresponding values. See (‘NIVY Data Factory > Watch Settings’)

Sample URL: https://datafactory.nivy.watch/api/Settings

Response:

 

[
{
“Id”: “7e30b4ea-4423-451b-92d0-00e0ee144c30”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Update Folder”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “update_folder”,
“TheValue”: “Update_Beta”,
“ValueDescription”: “FTP folder”
},
{
“Id”: “31270cbf-45dd-4d2a-b64f-0e57e35bf773”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “User management”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “user_management”,
“TheValue”: “Off”,
“ValueDescription”: “On/Off (in development)”
},
{
“Id”: “80f8be4a-c4d1-46bc-899d-4c7db5e7dd59”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Biometrics”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “biometrics”,
“TheValue”: “on”,
“ValueDescription”: “off – no data; \”on\” – only 0 or 1; \”values\” – real values”
},
{
“Id”: “4442391b-c4e8-4be0-a756-4e6e6dd293e4”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Beacon zone”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “beacon_zone”,
“TheValue”: “10”,
“ValueDescription”: “Distance in metres”
},
{
“Id”: “e75f8a01-791e-4817-9518-6b28011511eb”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Brightness Normal”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “brightness_normal”,
“TheValue”: “100”,
“ValueDescription”: “Brightness of display in normal mode  in %”
},
{
“Id”: “1094b54b-7fe0-4501-bf95-6b8b0b3f71c2”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Brightness Charge”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “brightness_charge”,
“TheValue”: “20”,
“ValueDescription”: “Brightness of display during charging in %”
},
{
“Id”: “577a25a8-e76a-4a72-b24a-345e74011a01”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Sync interval”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “sync_interval”,
“TheValue”: “3600”,
“ValueDescription”: “Sync Interval in seconds”
},
{
“Id”: “20a917be-0978-4de8-a480-977119cf48ed”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Beacon scan”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “beacon_scan”,
“TheValue”: “60”,
“ValueDescription”: “Beacon scanning interval in s”
},
{
“Id”: “1b6988a1-a104-481a-88ac-ba29c43cd97f”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Biometrics (Hajty)”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: “cac22bcf-ac6a-4513-ba9a-4caa0180d1eb”,
“WatchName”: “Hajty Azure”,
“Parameter”: “biometrics”,
“TheValue”: “value”,
“ValueDescription”: null
},
{
“Id”: “4185b610-5ec7-4ee6-a68d-ba2fef6d6d6e”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Distancing far zone”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “distancing_zone_far”,
“TheValue”: “5”,
“ValueDescription”: “Distance in metres”
},
{
“Id”: “b89dca2b-ba28-4940-8af0-c089522dbf8e”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Distancing near zone”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “distancing_zone_near”,
“TheValue”: “3”,
“ValueDescription”: “Distance in metres”
},
{
“Id”: “d94a83b6-d911-4bf3-b38c-c245826f7ca1”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Show distance”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “show_distance”,
“TheValue”: “On”,
“ValueDescription”: “Show distance/duration”
},
{
“Id”: “58664d18-8347-4094-baff-e01c3c91da51”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Brightness Sleep”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “brightness_sleep”,
“TheValue”: “0”,
“ValueDescription”: “Brightness of display in sleep mode in %”
},
{
“Id”: “f203e99b-ea6d-4221-bef1-e327b348b9c9”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Sync Messages”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “sync_msg_interval”,
“TheValue”: “15”,
“ValueDescription”: null
},
{
“Id”: “6c44d781-959e-498a-b260-a9d2407acf9e”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Tilt detector”,
“Category”: 10001,
“CategoryName”: “Sensor”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “tilt_detector”,
“TheValue”: “0”,
“ValueDescription”: “Scanning  Interval in seconds”
},
{
“Id”: “00009bca-ff2e-4d29-8249-442f13b068cb”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Accelerometer”,
“Category”: 10001,
“CategoryName”: “Sensor”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “accelerometer”,
“TheValue”: “10”,
“ValueDescription”: “Scanning  Interval in seconds”
},
{
“Id”: “27dce860-3965-4b83-bc47-91d993be8e0d”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Heart rate (Hajty)”,
“Category”: 10001,
“CategoryName”: “Sensor”,
“Watch”: “cac22bcf-ac6a-4513-ba9a-4caa0180d1eb”,
“WatchName”: “Hajty Azure”,
“Parameter”: “heart_rate”,
“TheValue”: “60”,
“ValueDescription”: “Scanning Interval in seconds”
},
{
“Id”: “4fc17188-7646-470d-9140-12cf805eb729”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Battery”,
“Category”: 10001,
“CategoryName”: “Sensor”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “battery”,
“TheValue”: “600”,
“ValueDescription”: “Scanning  Interval in seconds”
},
{
“Id”: “6e6ff3c9-42ae-4e08-bdd8-249da8f181ba”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Heart rate”,
“Category”: 10001,
“CategoryName”: “Sensor”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “heart_rate”,
“TheValue”: “120”,
“ValueDescription”: “Scanning  Interval in seconds”
},
{
“Id”: “1ad1f8aa-73da-4b50-b69d-30e40cca0036”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Step counter”,
“Category”: 10001,
“CategoryName”: “Sensor”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “step_counter”,
“TheValue”: “10”,
“ValueDescription”: “Scanning  Interval in seconds”
}
]

GET api/Settings/{id}

List Setting information based on the setting ID

Sample URL: https://datafactory.nivy.watch/api/Settings/{id}

Body Parameters:

 

Name

Description

Type

Required

id

The ID of a single setting

Globally unique identifier

Yes

Response:

 

{
“Id”: “80f8be4a-c4d1-46bc-899d-4c7db5e7dd59”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“TheName”: “Biometrics”,
“Category”: 10000,
“CategoryName”: “General”,
“Watch”: null,
“WatchName”: null,
“Parameter”: “biometrics”,
“TheValue”: “on”,
“ValueDescription”: “off – no data; \”on\” – only 0 or 1; \”values\” – real values”
}

GET api/MessageResponseType

Response types are the pre-configured messages that are returned by the watch upon receiving a message. They can easily be configured from the GUI of the NIVY Data Factory (See ‘NIVY Data Factory > Messaging > Predefined Response Configuration’)

Sample URL: https://datafactory.nivy.watch/api/MessageResponseType

Response:

 

[
{
“Id”: “27c77ae2-8725-45be-af4e-1c770d134425”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Response_OK”
},
{
“Id”: “eac036f0-d4d9-4cc3-b03a-bf0de9da972b”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “how much pcs ?”
},
{
“Id”: “45281d85-a89d-474b-b678-d2546acd1718”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: ” 3 – 5 – 10 minutes”
},
{
“Id”: “ec24a295-f1b8-4722-965d-d2ebc088e495”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Response_YesNo”
},
{
“Id”: “858c9311-5b31-4269-a769-d5b41ac4ad4c”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Time “
}
]

GET api/MessageResponseType/{id}

List a single Response Type based on the setting ID

Sample URL: https://datafactory.nivy.watch/api/MessageResponseType/{id}

Body Parameters:

 

Name

Description

Type

Required

id

The ID of a single response type

Globally unique identifier

Yes

Response:

 

{
“Id”: “27c77ae2-8725-45be-af4e-1c770d134425”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Response_OK”
}

GET api/MessageBox?toId={toId}

List all messages sent to a single device

Sample URL: https://datafactory.nivy.watch/api/MessageBox?toId=19ad743a-3f51-411a-b590-c163241fe337

Body Parameters:

 

Name

Description

Type

Required

told

The ID of a watch

Globally unique identifier

Yes

Response:

 

   {
“Id”: “193fa8f9-ee6d-484f-8492-77cffe8c06de”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“FromWatch”: null,
“FromName”: “nivywatch_test”,
“FromOrg”: true,
“ToWatch”: “19ad743a-3f51-411a-b590-c163241fe337”,
“ToName”: “Dale’s Watch”,
“ToOrg”: false,
“TheMessage”: “I need your assistance.”,
“ResponseType”: “3f7c5be3-1703-42e3-8331-ff8afd2395b8”,
“ResponseTypeName”: “Response_YesNo”,
“ResponseValue”: null,
“ResponseValueName”: null,
“ServiceVersion”: null,
TimeReceived: “2022-05-11T12:59:04”,
“TimeResponse”: null,
“TimeCreated”: “2022-05-11T12:58:54.6324408”,
“User”: null,
“UserName”: null,
“FirmwareVersion”: null,
“Received”: true
},
{
“Id”: “11111111-1111-1111-1111-111111111111”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“FromWatch”: null,
“FromName”: “nivywatch_test”,
“FromOrg”: true,
“ToWatch”: “19ad743a-3f51-411a-b590-c163241fe337”,
“ToName”: “Dale’s Watch”,
“ToOrg”: false,
“TheMessage”: “I need your assistance.”,
“ResponseType”: “3f7c5be3-1703-42e3-8331-ff8afd2395b8”,
“ResponseTypeName”: “Response_YesNo”,
“ResponseValue”: null,
“ResponseValueName”: null,
“ServiceVersion”: null,
TimeReceived: “2022-05-11T13:05:31”,
“TimeResponse”: null,
“TimeCreated”: “2022-05-11T13:05:30.0971726”,
“User”: null,
“UserName”: null,
“FirmwareVersion”: null,
“Received”: true
}

GET api/MessageBox/{id}

Display a single messages by the message ID

Sample URL: https://datafactory.nivy.watch/api/MessageBox/193fa8f9-ee6d-484f-8492-77cffe8c06de

Body Parameters:

 

Name

Description

Type

Required

id

The ID of the message

Globally unique identifier

Yes

Response:

 

{
“Id”: “193fa8f9-ee6d-484f-8492-77cffe8c06de”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“FromWatch”: null,
“FromName”: “nivywatch_test”,
“FromOrg”: true,
“ToWatch”: “19ad743a-3f51-411a-b590-c163241fe337”,
“ToName”: “Dale’s Watch”,
“ToOrg”: false,
“TheMessage”: “I need your assistance.”,
“ResponseType”: “3f7c5be3-1703-42e3-8331-ff8afd2395b8”,
“ResponseTypeName”: “Response_YesNo”,
“ResponseValue”: null,
“ResponseValueName”: null,
“ServiceVersion”: null,
TimeReceived: “2022-05-11T12:59:04”,
“TimeResponse”: null,
“TimeCreated”: “2022-05-11T12:58:54.6324408”,
“User”: null,
“UserName”: null,
“FirmwareVersion”: null,
“Received”: true
}

POST api/MessageBox

Sends a message to a single device. The message and response can all be specified in the Body Parameters

Sample URL: https://datafactory.nivy.watch/api/MessageBox

Body Parameters:

 

Name

Description

Type

Required

id

The ID of the message

globally unique identifier

Yes

BranchId

Option to specify which branch the message is to be sent from

globally unique identifier

No

FromWatch

Option to specify which watch the message is to be sent from

globally unique identifier

No

FromName

Option to specify which name the message is to be sent from

string

No

FromOrg

If the message is to from the organisation

boolean

Yes

ToWatch

ID of the Watch of which to send the Message

globally unique identifier

Yes

ToName

Option to specify the name of the recipient

string

No

ToOrg

If the message is to the organisation

boolean

Yes

TheMessage

The message text

string

Yes

ResponseType

The response type ID

globally unique identifier

Yes

GET api/ConfigWatchGroup

Reserved for future functionality

GET api/ConfigWatchGroup/{id}

Reserved for future functionality

GET api/MessageResponseValue?responseType={responseType}

List Possible Responses from MessageResponseTypes. Message Response Types can be easily configured in the NIVY Data Factory (See ‘NIVY Data Factory > Messaging > Predefined Response Configuration’)

Sample URL: https://datafactory.nivy.watch/api/MessageResponseValue?responseType=45281d85-a89d-474b-b678-d2546acd1718

Body Parameters:

 

Name

Description

Type

Required

id

The ID of the response type

Globally unique identifier

Yes

Response:

 

[
{
“Id”: “d713109d-0455-47a7-a00f-149455f179ff”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Value 3”,
“ResponseType”: “45281d85-a89d-474b-b678-d2546acd1718”,
“ResponseTypeName”: ” 3 – 5 – 10 minutes”,
“Text”: “3 min”,
“Sort”: 0
},
{
“Id”: “6854204a-56aa-41df-be83-d92e762af775”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Value 5”,
“ResponseType”: “45281d85-a89d-474b-b678-d2546acd1718”,
“ResponseTypeName”: ” 3 – 5 – 10 minutes”,
“Text”: “5 min”,
“Sort”: 1
},
{
“Id”: “7bee4467-273f-49ed-af9d-acbdd6970bca”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Value 10”,
“ResponseType”: “45281d85-a89d-474b-b678-d2546acd1718”,
“ResponseTypeName”: ” 3 – 5 – 10 minutes”,
“Text”: “10 min”,
“Sort”: 2
}
]

GET api/MessageResponseValue/{id}

Display the details of an individual response type. Message Response Types can be easily configured in the NIVY Data Factory (See ‘NIVY Data Factory > Messaging > Predefined Response Configuration’)

Sample URL: https://datafactory.nivy.watch/api/MessageResponseValue/6854204a-56aa-41df-be83-d92e762af775

Body Parameters:

 

Name

Description

Type

Required

id

The ID of the individual response type

Globally unique identifier

Yes

Response:

 

{
“Id”: “6854204a-56aa-41df-be83-d92e762af775”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Value 5”,
“ResponseType”: “45281d85-a89d-474b-b678-d2546acd1718”,
“ResponseTypeName”: ” 3 – 5 – 10 minutes”,
“Text”: “5 min”,
“Sort”: 1
}

GET api/ConfigWatches

Lists all Watches configured on the organisation

Sample URL: https://datafactory.nivy.watch/api/ConfigWatches

Response:

 

   {
“Id”: “cb928428-f30f-4076-97bb-c4f4acf8486b”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Dale Azure”,
“SerialNr”: “355763056830536”,
Watchface: “Digital Full”,
“WatchfaceId”: 10002,
“AlwaysTime”: false,
“DeveloperMode”: true,
“ScreenOnRaising”: false,
“LastSync”: “2022-05-12T11:56:12.7748156”
},
{
“Id”: “735b7948-d1e9-4643-8402-ccad78c1097c”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Rado Azure”,
“SerialNr”: “355763056835725”,
Watchface: “Digital Full”,
“WatchfaceId”: 10002,
“AlwaysTime”: false,
“DeveloperMode”: true,
“ScreenOnRaising”: false,
“LastSync”: “2022-05-12T11:51:28.4531578”
}

GET api/ConfigWatches/{id}

Display a single Watches configuration by  ID

Sample URL: https://datafactory.nivy.watch/api/ConfigWatches/cb928428-f30f-4076-97bb-c4f4acf8486b

Body Parameters:

 

Name

Description

Type

Required

id

The ID of the watch

Globally unique identifier

Yes

Response:

 

{
“Id”: “cb928428-f30f-4076-97bb-c4f4acf8486b”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Dale Azure”,
“SerialNr”: “355763056830536”,
Watchface: “Digital Full”,
“WatchfaceId”: 10002,
“AlwaysTime”: false,
“DeveloperMode”: true,
“ScreenOnRaising”: false,
“LastSync”: “2022-05-12T11:56:12.7748156”
}

GET api/ConfigWatches?serialNr={serialNr}

Display a single Watches configuration by its Serial Number

Sample URL: https://datafactory.nivy.watch/api/ConfigWatches?serialNr=355763056830536

Body Parameters:

 

Name

Description

Type

Required

serialNr

The serial number of the watch

String

Yes

Response:

 

{
“Id”: “cb928428-f30f-4076-97bb-c4f4acf8486b”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Dale Azure”,
“SerialNr”: “355763056830536”,
Watchface: “Digital Full”,
“WatchfaceId”: 10002,
“AlwaysTime”: false,
“DeveloperMode”: true,
“ScreenOnRaising”: false,
“LastSync”: “2022-05-12T11:56:12.7748156”
}

GET api/ConfigActivities

Lists all Activities available on the NIVY Data Factory. They can easily be configured from the GUI of the NIVY Data Factory (See ‘NIVY Data Factory > Activities’)

Sample URL: https://datafactory.nivy.watch/api/ConfigActivities

Response:

 

   {
“Id”: “b047f99b-7f8c-4ddf-b5eb-b40d4173ad0e”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Call”,
“Action”: null,
“Sort”: 1
},
{
“Id”: “053a1a65-4790-4e55-bcbe-751dd97e794d”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Coffee break”,
“Action”: null,
“Sort”: 2
},
{
“Id”: “aadce396-1c3d-47f3-97f6-99e95842369f”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Lunch”,
“Action”: null,
“Sort”: 3
}

GET api/ConfigActivities/{id}

Display a single activities configuration by  ID

Sample URL: https://datafactory.nivy.watch/api/ConfigActivities/b047f99b-7f8c-4ddf-b5eb-b40d4173ad0e

Body Parameters:

 

Name

Description

Type

Required

id

The ID of the activity

Globally unique identifier

Yes

Response:

 

{
“Id”: “b047f99b-7f8c-4ddf-b5eb-b40d4173ad0e”,
“BranchId”: “ea2e4299-7508-47a8-af6a-aa3690559e69”,
“Name”: “Call”,
“Action”: null,
“Sort”: 1
}

Troubleshooting

NIVY Watch

 

Device Errors

Error Code

Error Type

Solution

D001

Frozen or unresponsive device

Press and hold the power button for 10–15 seconds, a hard reset will be performed.

D002

Device not charging

Check the power supply to the charging station or dock. Ensure the pins are clean, and the spring mechanism is working.

Clean the contacts on the NIVY Watch. If the issue persists, please contact a NIVY Service Centre.

D003

Touchscreen unresponsive

Hard reset the device by pressing and holding the power button for 10-15 seconds. If the issue persists, please contact a NIVY Service Centre.

Software Errors

DS001

Device not synchronising

  1. Check Wi-Fi Connection
  2. Open ‘Main Menu > Info’ and ensure the device is linked to the correct organisation
  3. Force a manual update (See ‘NIVY Watch OS > Service Menu’)
  4. Unregister and re-register the device (See ‘NIVY Watch OS > Register Device’)
  5. If the problem persists, please contact NIVY Support

DS002

Device continues to vibrate after receiving a message

  1. Close NIVY Messaging
  1. Press and hold the Power Button until the power menu appears (See ‘NIVY Watch OS > Power Menu’)
  2. Tap ‘Recent Tasks’
  3. Locate ‘NIVY Messaging’ by scrolling up and down
  4. Swipe right or left
  1. Restart
  1. Press and hold the Power Button until the power menu appears (See ‘NIVY Watch OS > Power Menu’)
  2. Tap Restart
  1. Check the NIVY Data Factory for backlogged messages
  2. If the problem persists, please contact NIVY Support

DS003

Error “Cannot Connect to Update Server”

  1. Check the device is connected to Wi-Fi (See ‘NIVY Watch OS > Connect to Wi-Fi’)
  2. Check the device is registered (See ‘NIVY Watch OS > Register Device’)

Glossary

 

Name

Description

Android Debug Bridge (ADB)

A command line tool that enables you to communicate with an Android device

Area

A name for an area in a building or location that can contain several beacons

Beacon

A small bluetooth device that is normally powered by batteries emitting a signal at set intervals

Launcher

An application that provides a UI (User Interface) for the user

Multi-Charging Station (MCS)

A charging station for the charging of many NIVY Watch Devices

NIVY Developer Dock

A dock that enables the NIVY Watch to connect to a computer

NIVY Launcher

The main application running on the NIVY Watch where applications are launched and activities are selected

NIVY Messaging

A NIVY Application that controls messaging to and from devices

Power Menu

A menu with multiple power settings such as restart and power off

Quad Charging Station

A 4 place charging station

Recent Tasks

An Android application that enables you to view open application on an Android device

SMD Pin

A spring loaded pin used on charging stations and docks

Zone

The range of a singular device in which it is detected. For Example, if a beacon has a zone of 7 metres and the NIVY Watch is 3 metres from the beacon, it would be within the beacons ‘zone’