Skip to content
Documentation
/
Diabetes Device Data Mode...
/
/
Controller Settings (`con...
Last updated

Controller Settings (controllerSettings)

Quick Summary

annotationsArray of Annotation (object) or Blood Glucose Out of Range (object)(Annotation Array)[ 0 .. 100 ] itemsunique

An array of annotations.

archivedTimestring(date-time)(Date/Time)read-only
Example: "2017-02-06T02:37:46Z"
archivedDatasetIdstring(Data Set ID)[ 17 .. 37 ] characters^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...
Example: "ce8cc5f7595575945f91fc6710db6fef"
associationsArray of Association (blob) (object) or Association (datum) (object) or Association (image) (object) or Association (url) (object)(Association Array)

An array of associations for the resource.

clockDriftOffsetinteger(int64)(Clock Drift Offset)[ -86400000 .. 86400000 ]

Clock drift offset, expressed as milliseconds.

Example: 0
conversionOffsetinteger(int64)(Conversion Offset)

Conversion offset, expressed as milliseconds.

Example: 0
createdTimestring(date-time)(Date/Time)
Example: "2017-02-06T02:37:46Z"
createdUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

deduplicatorobject(Deduplicator Descriptor)
deletedTimestring(date-time)(Date/Time)
Example: "2017-02-06T02:37:46Z"
deletedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

deviceIdstring(Device ID)non-empty

Globally unique to device and repeatable with each upload, e.g. device make and model with serial number

Example: "MMT-1711:12345678"
deviceTimestring(Date/Time without Timezone)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$
Example: "2017-02-06T02:37:46"
historyArray of objects(Event History [Proposed])

Revision history of the event

idstring(Data Set ID)[ 17 .. 37 ] characters^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f...required
Example: "ce8cc5f7595575945f91fc6710db6fef"
locationobject(Location)

Location information associated with the resource. One or both of name and gps must be specified.

modifiedTimestring(date-time)(Date/Time)
Example: "2017-02-06T02:37:46Z"
modifiedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

notesArray of strings(Note Array)[ 1 .. 100 ] items

An array of 1 to 100 notes.

originobject(Origin)

External origin information for the source of the resource.

payloadobject(Payload)

Grab bag field for data that isn't yet part of the data model. The maximum size is 4K bytes.

sourcestring
Value"carelink"
tagsArray of strings(Tag Array)

An array of tags.

timestring(date-time)(Date/Time)required
Example: "2017-02-06T02:37:46Z"
timezonestring(Time Zone)
Example: "Europe/London"
timezoneOffsetinteger(int32)(Time Zone offset)[ -10080 .. 10080 ]

Time zone offset, expressed as positive or negative number of minutes from UTC.

Example: -420
typestring(Tidepool Data Type)required

Data type

Enum"controllerSettings""alert""basal""bloodKetone""bolus""cbg""cgmSettings""controllerStatus""deviceEvent""deviceStatus"
Example: "upload"
uploadIdstring(Upload ID)[ 17 .. 32 ] characters^([0-9a-f]{32}|upid_[0-9a-f]{12})$

An upload identifier; this field should be the uploadId of the corresponding upload record

Example: "0d92d5c1c22117a18f3620b9e24d3c06"
deviceobject(Controller Settings Device)

The device for the controller settings.

notificationsobject(Controller Settings Notifications)

The notifications for the controller settings.

guidstringDeprecated

A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.

Overview

This is the Tidepool data type representing the settings on a controller.

Platform does not currently accept deduplicate data, meaning if a user uploads the same data from both a pump and a receiver, Tidepool Uploader will reject one device's data and the deduplicate data will not appear.

Type (type)

This is the Tidepool data type to represent controller settings at a given point in time.

Device (device)

The device related settings of the controller, if known. The device settings contain the following fields:

Firmware Version (firmwareVersion)

The firmware version of the controller, if known.

Hardware Version (hardwareVersion)

The hardware version of the controller, if known.

Manufacturers (manufacturers)

The manufacturer(s) of the controller. An array of strings.

Model (model)

The model of the controller, if known.

Name (name)

The name of the controller, if known.

Serial Number (serialNumber)

The serial number of the controller, if known.

Software Version (softwareVersion)

The software version of the controller, if known.

Notifications (notifications)

The notification related settings of the controller, if known. The notification settings contain the following fields:

Authorization (authorization)

Indicates whether notifications are allowed on the controller or not. One of the following:

  • authorized - The controller is authorized to schedule or receive user notifications.
  • denied - The controller is explicitly NOT authorized to schedule or receive user notifications.
  • ephemeral - The controller is authorized to schedule or receive user notifications for a limited amount of time
  • notDetermined - Not yet determined if the controller is authorized to schedule or receive user notifications.
  • provisional - The controller is provisionally authorized to post noninterruptive user notifications.

Alert (alert)

Whether a normal alert can be presented as a user notification.

Critical Alert (criticalAlert)

Whether a critical alert can be presented as a user notification.

Badge (badge)

Whether a badge can be added to the controller icon as a user notification.

Sound (sound)

Whether a sound can be played as part of a user notification.

Announcement (announcement)

Whether an spoken announcement can be presented a part of a user notification.

Notification Center (notificationCenter)

Whether the central notification center can present a user notification.

Lock Screen (lockScreen)

Whether a user notification can be preseted on the lock screen of the controller.

Alert Style (alertStyle)

The style of alert when normal alert is presented as a user notification. One of the following:

  • alert - Alerts are displayed in a modal window that must be dismissed explicitly by the user.
  • banner - Alerts are displayed as a slide-down banner. Banners appear for a short time and then disappear automatically if the user does nothing.
  • none - No alert is displayed.
Example
{
    "id": "02ccebd2affc472d9b296d4f1f800dfd",
    "time": "2018-05-14T08:17:07.560Z",
    "type": "controllerSettings",
    "device": {
        "firmwareVersion": "1.2",
        "hardwareVersion": "2.3r45",
        "manufacturers": [
            "Acme"
        ],
        "model": "Super Controller",
        "name": "My Controller",
        "serialNumber": "1234567890",
        "softwareVersion": "3.4.5"
    },
    "notifications": {
        "authorization": "authorized",
        "alert": true,
        "criticalAlert": true,
        "badge": true,
        "sound": true,
        "announcement": true,
        "notificationCenter": true,
        "lockScreen": true,
        "alertStyle": "alert"
    },
    "uploadId": "0d92d5c1c22117a18f3620b9e24d3c06"
}

Keep Reading

Previous page
Next page