{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["json-schema"]},"type":"markdown"},"seo":{"title":"Controller Settings ( controllerSettings )","llmstxt":{"hide":true}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"controller-settings--controllersettings-","__idx":0},"children":["Controller Settings (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["controllerSettings"]},")"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"quick-summary","__idx":1},"children":["Quick Summary"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../../../reference/data/models/controllersettings/controllersettings.v1.yaml"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/controllersettings.v1"},"code.v1":{"title":"Annotation Code","description":"Annotation codes that appear in Tidepool diabetes data records.\nThe annotation codes are primarily intended for machine processing, but they are usually readable enough to make sense.\nThese are by convention structured as series of strings separated by slashes (`/`), in order from more general to more specific.\nFor example:\n\n  * `wrong-device-time` or `time-change`, generic annotations.\n  * `basal/unknown-duration` or `bg/out-of-range`, generic annotations around a particular theme.\n  * `medtronic/basal/flat-rate`, a manufacturer-specific annotation.\n  * `medtronic600/smbg/user-rejected-remote-bg`, a device-specific annotation.","type":"string","minLength":1,"pattern":"^[0-9a-z\\-_]+(/[0-9a-z\\-_]+(/[0-9a-z\\-_]+)?)?$","enum":["animas/basal/flat-rate","animas/basal/marked-suspended-from-alarm","animas/bolus/extended-equal-split","animas/bolus/unknown-duration","animas/out-of-sequence","animas/status/fabricated-from-alarm","basal/auto","basal/intersects-incomplete-suspend","basal/mismatched-series","basal/unknown-duration","bg/out-of-range","carelink/basal/fabricated-from-schedule","carelink/basal/fabricated-from-suppressed","carelink/basal/off-schedule-rate","carelink/bolus/missing-square-component","carelink/wizard/long-search","final-basal/fabricated-from-schedule","insulet/basal/fabricated-from-schedule","insulet/bolus/split-extended","medtronic/basal/fabricated-from-schedule","medtronic/basal/flat-rate","medtronic/basal/one-second-gap","medtronic/basal/time-change","medtronic/status/fabricated-from-device-event","medtronic/wizard/carb-to-exchange-ratio-deconverted","medtronic600/smbg/bg-reading-received","medtronic600/smbg/bg-sent-for-calib","medtronic600/smbg/bg-si-fail-result-recd-frm-gst","medtronic600/smbg/bg-si-pass-result-recd-frm-gst","medtronic600/smbg/entered-as-bg-marker","medtronic600/smbg/entered-in-bg-entry","medtronic600/smbg/entered-in-bolus-wizard","medtronic600/smbg/entered-in-meal-wizard","medtronic600/smbg/entered-in-sensor-calib","medtronic600/smbg/remote-bg-acceptance-screen-timeout","medtronic600/smbg/user-accepted-remote-bg","medtronic600/smbg/user-rejected-remote-bg","medtronic600/smbg/user-rejected-sensor-calib","spring-forward","stats-how-calculated","stats-how-calculated-average-cbg","stats-how-calculated-average-smbg","stats-how-calculated-range-cbg","stats-how-calculated-range-smbg","stats-how-calculated-ratio","stats-insufficient-data","status/incomplete-tuple","tandem/basal/fabricated-from-new-day","tandem/basal/temp-without-rate-change","tandem/pumpSettingsOverride/estimated-duration","tandem/pumpSettingsOverride/fabricated-from-new-day","time-change","uncertain-timestamp","wizard/target-automated","wrong-device-time"],"example":"wrong-device-time"},"bgoutofrange.v1":{"title":"Blood Glucose Out of Range","type":"object","properties":{"code":{"type":"string","enum":["bg/out-of-range"],"example":"bg/out-of-range"},"value":{"type":"string","enum":["low","high"],"example":"low"},"threshold":{"type":"number","example":40}},"required":["code","value","threshold"]},"annotation.v1":{"title":"Annotation","description":"Annotation attached to the diabetes data record to provide additional information. Annotation is at minimum a `code` (string) that describes the annotation. It may also include additional properties that further describe the annotation. The maximum size is 4K bytes.","type":"object","allOf":[{"type":"object","properties":{"code":{"$ref":"#/components/schemas/code.v1"}},"required":["code"]},{"oneOf":[{"type":"object","properties":{"code":{"$ref":"#/components/schemas/code.v1"}},"required":["code"]},{"$ref":"#/components/schemas/bgoutofrange.v1"}]}]},"annotationarray.v1":{"title":"Annotation Array","description":"An array of annotations.","type":"array","uniqueItems":true,"minItems":0,"maxItems":100,"items":{"$ref":"#/components/schemas/annotation.v1"}},"datetime.v1":{"title":"Date/Time","description":"[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) / [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp _with_ timezone information","type":"string","format":"date-time","example":"2017-02-06T02:37:46Z","x-go-type":"string"},"datasetid.v1":{"title":"Data Set ID","type":"string","pattern":"^(upid_[0-9a-f]{12}|upid_[0-9a-f]{32}|[0-9a-f]{32})$","minLength":17,"maxLength":37,"example":"ce8cc5f7595575945f91fc6710db6fef","x-tags":["Data"]},"association-type.v1":{"title":"Association Type","description":"The type of the association. If type is `blob`, `datum`, or `image`, then `id` must also be specified. If type is `url`, then url must also be specified.","type":"string","enum":["blob","datum","image","url"],"example":"blob","x-go-type":"string"},"reason.v1":{"title":"Association Reason","description":"The reason for the association.","type":"string","minLength":1,"maxLength":1000},"association-id.v1":{"title":"Association ID","description":"The ID of the associated Tidepool resource if type is blob, datum, or image.","type":"string"},"url.v1":{"title":"URL","description":"URL","type":"string","format":"uri"},"blob.v1":{"title":"Association (blob)","type":"object","properties":{"type":{"$ref":"#/components/schemas/association-type.v1"},"reason":{"$ref":"#/components/schemas/reason.v1"},"id":{"$ref":"#/components/schemas/association-id.v1"},"url":{"$ref":"#/components/schemas/url.v1"}},"required":["type","id"]},"datum.v1":{"title":"Association (datum)","type":"object","properties":{"type":{"$ref":"#/components/schemas/association-type.v1"},"reason":{"$ref":"#/components/schemas/reason.v1"},"id":{"$ref":"#/components/schemas/association-id.v1"},"url":{"$ref":"#/components/schemas/url.v1"}},"required":["type","id"]},"image.v1":{"title":"Association (image)","type":"object","properties":{"type":{"$ref":"#/components/schemas/association-type.v1"},"reason":{"$ref":"#/components/schemas/reason.v1"},"id":{"$ref":"#/components/schemas/association-id.v1"},"url":{"$ref":"#/components/schemas/url.v1"}},"required":["type","id"]},"url-association.v1":{"title":"Association (url)","type":"object","properties":{"type":{"$ref":"#/components/schemas/association-type.v1"},"reason":{"$ref":"#/components/schemas/reason.v1"},"id":{"$ref":"#/components/schemas/association-id.v1"},"url":{"$ref":"#/components/schemas/url.v1"}},"required":["type","id","url"]},"association.v1":{"title":"Association","description":"Associate this resource with another Tidepool resource ID.","type":"object","oneOf":[{"$ref":"#/components/schemas/blob.v1"},{"$ref":"#/components/schemas/datum.v1"},{"$ref":"#/components/schemas/image.v1"},{"$ref":"#/components/schemas/url-association.v1"}]},"associationarray.v1":{"title":"Association Array","description":"An array of associations for the resource.","type":"array","items":{"$ref":"#/components/schemas/association.v1"}},"clockdriftoffset.v1":{"title":"Clock Drift Offset","description":"Clock drift offset, expressed as milliseconds.","type":"integer","format":"int64","minimum":-86400000,"maximum":86400000,"example":0,"x-tags":["Data"]},"conversionoffset.v1":{"title":"Conversion Offset","description":"Conversion offset, expressed as milliseconds.","type":"integer","format":"int64","example":0,"x-tags":["Data"]},"tidepooluserid":{"type":"string","title":"Tidepool User ID","pattern":"^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","description":"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](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random))","readOnly":true,"x-go-type":"string"},"semanticversion.v1":{"title":"Semantic Version Number","description":"[Semantic Version Number 2.0.0](http://semver.org/). Regex from their [site](https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string).","type":"string","minLength":5,"pattern":"^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$","example":"2.36.1"},"reversedomainname.v1":{"title":"Reverse Domain Name","description":"Name in the [reverse domain name notation](https://en.wikipedia.org/wiki/Reverse_domain_name_notation).","type":"string","pattern":"^[a-zA-Z0-9](|[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])(\\.[a-zA-Z0-9](|[a-zA-Z0-9-]{0,61}[a-zA-Z0-9]))+$","example":"org.tidepool.uploader"},"deduplicatordescriptor.v1":{"title":"Deduplicator Descriptor","type":"object","properties":{"hash":{"type":"string","minLength":1},"version":{"$ref":"#/components/schemas/semanticversion.v1"},"name":{"$ref":"#/components/schemas/reversedomainname.v1"}},"required":["name","version"],"x-tags":["Data"]},"deviceid.v1":{"title":"Device ID","description":"Globally unique to device and repeatable with each upload, e.g. device make and model with serial number","type":"string","minLength":1,"example":"MMT-1711:12345678","x-tags":["Data"]},"datetimenotz.v1":{"title":"Date/Time without Timezone","description":"[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) / [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp _without_ timezone information","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","example":"2017-02-06T02:37:46","x-go-type":"string"},"jsonpatch.v1":{"title":"JSONPatch","oneOf":[{"properties":{"op":{"type":"string","description":"The operation to perform.","enum":["add","replace","test"]},"path":{"type":"string","description":"A JSON Pointer path."},"value":{"description":"The value to add, replace or test."}},"required":["op","path","value"]},{"properties":{"op":{"type":"string","description":"The operation to perform.","enum":["remove"]},"path":{"type":"string","description":"A JSON Pointer path."}},"required":["op","path"]},{"properties":{"op":{"type":"string","description":"The operation to perform.","enum":["move","copy"]},"from":{"description":"A JSON Pointer path pointing to the location to move/copy from.","type":"string"},"path":{"type":"string","description":"A JSON Pointer path."}},"required":["op","from","path"]}],"type":"object","description":"Only have this here because Stoplight doesn't seem to like using the JSONSchema directly as a ref from http://json.schemastore.org/json-patch"},"eventhistory.v1":{"title":"Event History [Proposed]","description":"Revision history of the event","type":"array","items":{"type":"object","properties":{"time":{"$ref":"#/components/schemas/datetime.v1"},"changes":{"$ref":"#/components/schemas/jsonpatch.v1"}},"required":["time","changes"]},"x-tags":["Data"]},"origin-id.v1":{"title":"Origin ID","description":"Any external identifier uniquely identifying the resource at the origin source.","type":"string","minLength":1,"maxLength":100},"name.v1":{"title":"Origin Name","description":"A human-readable name for the origin source.","type":"string","minLength":1,"maxLength":100},"payload.v1":{"title":"Payload","description":"Grab bag field for data that isn't yet part of the data model. The maximum size is 4K bytes.","type":"object","additionalProperties":true},"origin-type.v1":{"title":"Origin Type","description":"The type of the origin source.","type":"string","enum":["application","device","manual","service"],"example":"device"},"version.v1":{"title":"Origin Version","description":"The version of the origin source at the time the resources was obtained.","type":"string","minLength":1,"maxLength":100},"origin.v1":{"title":"Origin","description":"External origin information for the source of the resource.","type":"object","properties":{"id":{"$ref":"#/components/schemas/origin-id.v1"},"name":{"$ref":"#/components/schemas/name.v1"},"payload":{"$ref":"#/components/schemas/payload.v1"},"time":{"$ref":"#/components/schemas/datetime.v1"},"type":{"$ref":"#/components/schemas/origin-type.v1"},"version":{"$ref":"#/components/schemas/version.v1"}},"required":["id","name","time","type","version"]},"longitude.v1":{"title":"Longitude","description":"The prime meridian, which passes near the Royal Observatory, Greenwich, England, is defined as 0° longitude by convention. Positive longitudes are east of the prime meridian, and negative ones are west.","type":"object","properties":{"units":{"type":"string","enum":["degrees"],"example":"degrees"},"value":{"type":"number","format":"double","minimum":-180,"maximum":180,"example":-122.1625595}},"required":["units","value"]},"latitude.v1":{"title":"Latitude","description":"Latitude is an angle which ranges from -90° at the South pole to 0° at the Equator to 90° at the North pole.","type":"object","properties":{"units":{"type":"string","enum":["degrees"],"example":"degrees"},"value":{"type":"number","format":"double","minimum":-90,"maximum":90,"example":37.4454404}},"required":["units","value"]},"meters.v1":{"title":"Accuracy (meters)","description":"Accuracy of a measurement, expressed as meters.","type":"object","properties":{"value":{"type":"number","format":"double","minimum":0,"maximum":1000,"example":42},"units":{"type":"string","enum":["meters"],"example":"meters"}},"required":["units"]},"accuracy-feet.v1":{"title":"Accuracy (feet)","description":"Accuracy of a measurement, expressed in `feet`.","type":"object","properties":{"value":{"type":"number","format":"double","minimum":0,"maximum":3280,"example":42},"units":{"type":"string","enum":["feet"],"example":"feet"}},"required":["units"]},"accuracy.v1":{"title":"Accuracy","description":"Accuracy of a measurement","type":"object","oneOf":[{"$ref":"#/components/schemas/meters.v1"},{"$ref":"#/components/schemas/accuracy-feet.v1"}]},"floor.v1":{"title":"Floor","type":"integer","format":"int32","minimum":-1000,"maximum":1000},"elevation-meters.v1":{"title":"Elevation (meters)","type":"object","properties":{"units":{"type":"string","enum":["meters"],"example":"meters"},"value":{"type":"number","format":"double","minimum":0,"maximum":10000,"example":42}},"required":["units","value"]},"elevation-feet.v1":{"title":"Elevation (feet)","type":"object","properties":{"units":{"type":"string","enum":["feet"],"example":"feet"},"value":{"type":"number","format":"double","minimum":0,"maximum":32808,"example":42}},"required":["units","value"]},"elevation.v1":{"title":"Elevation","description":"Elevation, expressed as `meters` or `feet`.","type":"object","oneOf":[{"$ref":"#/components/schemas/elevation-meters.v1"},{"$ref":"#/components/schemas/elevation-feet.v1"}]},"gps.v1":{"title":"GPS","description":"GPS coordinates and related information.","type":"object","properties":{"origin":{"$ref":"#/components/schemas/origin.v1"},"longitude":{"$ref":"#/components/schemas/longitude.v1"},"latitude":{"$ref":"#/components/schemas/latitude.v1"},"horizontalAccuracy":{"$ref":"#/components/schemas/accuracy.v1"},"verticalAccuracy":{"$ref":"#/components/schemas/accuracy.v1"},"floor":{"$ref":"#/components/schemas/floor.v1"},"elevation":{"$ref":"#/components/schemas/elevation.v1"}},"required":["longitude","latitude"]},"location.v1":{"title":"Location","type":"object","description":"Location information associated with the resource. One or both of `name` and `gps` must be specified.","properties":{"name":{"type":"string","description":"A name for the location.","minLength":1,"maxLength":100},"gps":{"$ref":"#/components/schemas/gps.v1"}}},"note.v1":{"title":"Note","description":"A note associated with the resource.","type":"string","minLength":1,"maxLength":1000},"notearray.v1":{"title":"Note Array","description":"An array of 1 to 100 notes.","type":"array","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/note.v1"}},"tag.v1":{"title":"Tag","description":"A tag associated with the resource.","type":"string","minLength":1,"maxLength":100},"tagarray.v1":{"title":"Tag Array","description":"An array of tags.","type":"array","items":{"$ref":"#/components/schemas/tag.v1"}},"timezonename.v1":{"title":"Time Zone","description":"A string timezone name from the [IANA timezone database](https://www.iana.org/time-zones)","type":"string","example":"Europe/London","x-tags":["Data"]},"timezoneoffset.v1":{"title":"Time Zone offset","description":"Time zone offset, expressed as positive or negative number of minutes from UTC.","type":"integer","format":"int32","minimum":-10080,"maximum":10080,"example":-420,"x-tags":["Data"]},"datatype.v1":{"title":"Tidepool Data Type","description":"Data type","type":"string","enum":["alert","basal","bloodKetone","bolus","cbg","cgmSettings","controllerSettings","controllerStatus","deviceEvent","deviceStatus","dosingDecision","food","insulin","physicalActivity","pumpSettings","pumpStatus","reportedState","smbg","upload","water","wizard"],"example":"upload","x-tags":["Data"]},"uploadid.v1":{"title":"Upload ID","description":"An upload identifier; this field should be the uploadId of the corresponding upload record","type":"string","pattern":"^([0-9a-f]{32}|upid_[0-9a-f]{12})$","minLength":17,"maxLength":32,"example":"0d92d5c1c22117a18f3620b9e24d3c06","x-tags":["Data"]},"base.v1":{"title":"Base","description":"An abstract base data type for all Tidepool diabetes data objects.","type":"object","properties":{"annotations":{"$ref":"#/components/schemas/annotationarray.v1"},"archivedTime":{"allOf":[{"$ref":"#/components/schemas/datetime.v1"}],"readOnly":true},"archivedDatasetId":{"$ref":"#/components/schemas/datasetid.v1"},"associations":{"$ref":"#/components/schemas/associationarray.v1"},"clockDriftOffset":{"$ref":"#/components/schemas/clockdriftoffset.v1"},"conversionOffset":{"$ref":"#/components/schemas/conversionoffset.v1"},"createdTime":{"$ref":"#/components/schemas/datetime.v1"},"createdUserId":{"$ref":"#/components/schemas/tidepooluserid"},"deduplicator":{"$ref":"#/components/schemas/deduplicatordescriptor.v1"},"deletedTime":{"$ref":"#/components/schemas/datetime.v1"},"deletedUserId":{"$ref":"#/components/schemas/tidepooluserid"},"deviceId":{"$ref":"#/components/schemas/deviceid.v1"},"deviceTime":{"$ref":"#/components/schemas/datetimenotz.v1"},"guid":{"type":"string","description":"A string ID. Added to each event during data processing in the Tidepool Uploader or upon ingestion by the platform data ingestion service.","deprecated":true},"history":{"$ref":"#/components/schemas/eventhistory.v1"},"id":{"$ref":"#/components/schemas/datasetid.v1"},"location":{"$ref":"#/components/schemas/location.v1"},"modifiedTime":{"$ref":"#/components/schemas/datetime.v1"},"modifiedUserId":{"$ref":"#/components/schemas/tidepooluserid"},"notes":{"$ref":"#/components/schemas/notearray.v1"},"origin":{"$ref":"#/components/schemas/origin.v1"},"payload":{"$ref":"#/components/schemas/payload.v1"},"source":{"type":"string","enum":["carelink"]},"tags":{"$ref":"#/components/schemas/tagarray.v1"},"time":{"$ref":"#/components/schemas/datetime.v1"},"timezone":{"$ref":"#/components/schemas/timezonename.v1"},"timezoneOffset":{"$ref":"#/components/schemas/timezoneoffset.v1"},"type":{"$ref":"#/components/schemas/datatype.v1"},"uploadId":{"$ref":"#/components/schemas/uploadid.v1"}},"required":["id","type","time"],"x-tags":["Data"]},"device.v1":{"title":"Controller Settings Device","allOf":[{"type":"object","description":"The device for the controller settings.","properties":{"firmwareVersion":{"type":"string","maxLength":100,"minLength":1,"example":"1.2"},"hardwareVersion":{"type":"string","maxLength":100,"minLength":1,"example":"2.3r45"},"manufacturers":{"type":"array","items":{"type":"string","maxLength":100,"minLength":1},"maxLength":10,"minLength":1,"example":["Acme"]},"model":{"type":"string","maxLength":100,"minLength":1,"example":"Super Controller"},"name":{"type":"string","maxLength":100,"minLength":1,"example":"My Controller"},"serialNumber":{"type":"string","maxLength":100,"minLength":1,"example":"1234567890"},"softwareVersion":{"type":"string","maxLength":100,"minLength":1,"example":"3.4.5"}}}],"x-tags":["Data"]},"notifications.v1":{"title":"Controller Settings Notifications","allOf":[{"type":"object","description":"The notifications for the controller settings.","properties":{"authorization":{"type":"string","enum":["authorized","denied","ephemeral","notDetermined","provisional"]},"alert":{"type":"boolean"},"criticalAlert":{"type":"boolean"},"badge":{"type":"boolean"},"sound":{"type":"boolean"},"announcement":{"type":"boolean"},"notificationCenter":{"type":"boolean"},"lockScreen":{"type":"boolean"},"alertStyle":{"type":"string","enum":["alert","banner","none"]}}}],"x-tags":["Data"]},"controllersettings.v1":{"title":"Controller Settings","allOf":[{"$ref":"#/components/schemas/base.v1"},{"type":"object","description":"Controller settings","properties":{"type":{"type":"string","enum":["controllerSettings"]},"device":{"$ref":"#/components/schemas/device.v1"},"notifications":{"$ref":"#/components/schemas/notifications.v1"}}}],"x-tags":["Data"]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":2},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the Tidepool data type representing the settings on a controller."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"type--type-","__idx":3},"children":["Type (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the Tidepool data type to represent controller settings at a given point in time."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"device--device-","__idx":4},"children":["Device (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["device"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The device related settings of the controller, if known. The device settings contain the following fields:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#firmware-version-firmwareversion"},"children":["Firmware Version (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firmwareVersion"]},")"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#hardware-version-hardwareversion"},"children":["Hardware Version (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hardwareVersion"]},")"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#manufacturers-manufacturers"},"children":["Manufacturers (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["manufacturers"]},")"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#model-model"},"children":["Model (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["model"]},")"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#name-name"},"children":["Name (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},")"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#serial-number-serialnumber"},"children":["Serial Number (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serialNumber"]},")"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#software-version-softwareversion"},"children":["Software Version (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["softwareVersion"]},")"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"firmware-version--firmwareversion-","__idx":5},"children":["Firmware Version (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firmwareVersion"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The firmware version of the controller, if known."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"hardware-version--hardwareversion-","__idx":6},"children":["Hardware Version (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hardwareVersion"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The hardware version of the controller, if known."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"manufacturers--manufacturers-","__idx":7},"children":["Manufacturers (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["manufacturers"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The manufacturer(s) of the controller. An array of strings."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"model--model-","__idx":8},"children":["Model (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["model"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The model of the controller, if known."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"name--name-","__idx":9},"children":["Name (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The name of the controller, if known."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"serial-number--serialnumber-","__idx":10},"children":["Serial Number (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["serialNumber"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The serial number of the controller, if known."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"software-version--softwareversion-","__idx":11},"children":["Software Version (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["softwareVersion"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The software version of the controller, if known."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"notifications--notifications-","__idx":12},"children":["Notifications (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notifications"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The notification related settings of the controller, if known. The notification settings contain the following fields:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#authorization-authorization"},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#alert-alert"},"children":["Alert"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#critical-alert-criticalalert"},"children":["Critical Alert"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#badge-badge"},"children":["Badge"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#sound-sound"},"children":["Sound"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#announcement-announcement"},"children":["Announcement"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#notification-center-notificationcenter"},"children":["Notification Center"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#lock-screen-lockscreen"},"children":["Lock Screen"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#alert-style-alertstyle"},"children":["Alert Style"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authorization--authorization-","__idx":13},"children":["Authorization (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorization"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Indicates whether notifications are allowed on the controller or not. One of the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorized"]}," - The controller is authorized to schedule or receive user notifications."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["denied"]}," - The controller is explicitly NOT authorized to schedule or receive user notifications."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ephemeral"]}," - The controller is authorized to schedule or receive user notifications for a limited amount of time"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notDetermined"]}," - Not yet determined if the controller is authorized to schedule or receive user notifications."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["provisional"]}," - The controller is provisionally authorized to post noninterruptive user notifications."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"alert--alert-","__idx":14},"children":["Alert (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["alert"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether a normal alert can be presented as a user notification."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"critical-alert--criticalalert-","__idx":15},"children":["Critical Alert (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["criticalAlert"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether a critical alert can be presented as a user notification."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"badge--badge-","__idx":16},"children":["Badge (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["badge"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether a badge can be added to the controller icon as a user notification."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sound--sound-","__idx":17},"children":["Sound (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sound"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether a sound can be played as part of a user notification."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"announcement--announcement-","__idx":18},"children":["Announcement (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["announcement"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether an spoken announcement can be presented a part of a user notification."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"notification-center--notificationcenter-","__idx":19},"children":["Notification Center (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notificationCenter"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether the central notification center can present a user notification."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"lock-screen--lockscreen-","__idx":20},"children":["Lock Screen (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lockScreen"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether a user notification can be preseted on the lock screen of the controller."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"alert-style--alertstyle-","__idx":21},"children":["Alert Style (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["alertStyle"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The style of alert when normal alert is presented as a user notification. One of the following:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["alert"]}," - Alerts are displayed in a modal window that must be dismissed explicitly by the user."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["banner"]}," - Alerts are displayed as a slide-down banner. Banners appear for a short time and then disappear automatically if the user does nothing."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["none"]}," - No alert is displayed."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Example","header":{"title":"Example","controls":{"copy":{}}},"source":"{\n    \"id\": \"02ccebd2affc472d9b296d4f1f800dfd\",\n    \"time\": \"2018-05-14T08:17:07.560Z\",\n    \"type\": \"controllerSettings\",\n    \"device\": {\n        \"firmwareVersion\": \"1.2\",\n        \"hardwareVersion\": \"2.3r45\",\n        \"manufacturers\": [\n            \"Acme\"\n        ],\n        \"model\": \"Super Controller\",\n        \"name\": \"My Controller\",\n        \"serialNumber\": \"1234567890\",\n        \"softwareVersion\": \"3.4.5\"\n    },\n    \"notifications\": {\n        \"authorization\": \"authorized\",\n        \"alert\": true,\n        \"criticalAlert\": true,\n        \"badge\": true,\n        \"sound\": true,\n        \"announcement\": true,\n        \"notificationCenter\": true,\n        \"lockScreen\": true,\n        \"alertStyle\": \"alert\"\n    },\n    \"uploadId\": \"0d92d5c1c22117a18f3620b9e24d3c06\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"keep-reading","__idx":22},"children":["Keep Reading"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/device-data/annotations"},"children":["Annotations"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/device-data/common-fields"},"children":["Common Fields"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/device-data/oor-values"},"children":["Out Of Range Values"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/device-data/units"},"children":["Units"]}]}]}]},"headings":[{"value":"Controller Settings ( controllerSettings )","id":"controller-settings--controllersettings-","depth":1},{"value":"Quick Summary","id":"quick-summary","depth":2},{"value":"Overview","id":"overview","depth":2},{"value":"Type ( type )","id":"type--type-","depth":2},{"value":"Device ( device )","id":"device--device-","depth":2},{"value":"Firmware Version ( firmwareVersion )","id":"firmware-version--firmwareversion-","depth":3},{"value":"Hardware Version ( hardwareVersion )","id":"hardware-version--hardwareversion-","depth":3},{"value":"Manufacturers ( manufacturers )","id":"manufacturers--manufacturers-","depth":3},{"value":"Model ( model )","id":"model--model-","depth":3},{"value":"Name ( name )","id":"name--name-","depth":3},{"value":"Serial Number ( serialNumber )","id":"serial-number--serialnumber-","depth":3},{"value":"Software Version ( softwareVersion )","id":"software-version--softwareversion-","depth":3},{"value":"Notifications ( notifications )","id":"notifications--notifications-","depth":2},{"value":"Authorization ( authorization )","id":"authorization--authorization-","depth":3},{"value":"Alert ( alert )","id":"alert--alert-","depth":3},{"value":"Critical Alert ( criticalAlert )","id":"critical-alert--criticalalert-","depth":3},{"value":"Badge ( badge )","id":"badge--badge-","depth":3},{"value":"Sound ( sound )","id":"sound--sound-","depth":3},{"value":"Announcement ( announcement )","id":"announcement--announcement-","depth":3},{"value":"Notification Center ( notificationCenter )","id":"notification-center--notificationcenter-","depth":3},{"value":"Lock Screen ( lockScreen )","id":"lock-screen--lockscreen-","depth":3},{"value":"Alert Style ( alertStyle )","id":"alert-style--alertstyle-","depth":3},{"value":"Keep Reading","id":"keep-reading","depth":2}],"frontmatter":{"seo":{"title":"Controller Settings ( controllerSettings )"}},"lastModified":"2025-09-04T14:19:18.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/device-data/data-types/controller-settings","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}