Get full details about a single Accessory IdAccessory Id - A unique non changing value to identify a particular Accessory. Accessory Id's are globally unique and are UUID v4 strings. A new Accessory Id is assigned by the servers when a device is associated to an account for the first time. If the same physical device is re-associated to the same account, it will receive the same Accessory Id again. If the same physical device is re-associated to a different account, it will receive a new Accessory Id. Example: 70e3e6f9-70c3-45b2-62e4-ace3d027988a. This will include the name and current settings for the device. It can also include the current Service Plan Features.
Permissions
Requires a Permissions scope of: circle:accessories or circle:accessories_ro
Callers with circle:accessories_manage will receive extra response fields.
Response Body
Returns a JSON object representing the AccessoryAccessory - A unique device within the system. An accessory can be any of type and is represented by a unique Accessory Id. An accessory is linked to an account via an accountId. Within this API, a singular Circle camera is an Accessory.. Many of these field names are the same name and value as those found in the Set Accessory Config by Id.
Developers NOTE: The actual call may return more information than this list below. Any additional values may be removed at any time in the future. Contact Logitech if you need to use one of the undocumented fields as they may be removed at any time.
Main Object
Name | Type | Description |
---|---|---|
accountId | string | The Circle Account IdAccount Id - A unique non changing value to identify a particular Circle user account. Circle Account Id's are globally unique and are UUID v4 strings. The Account Id is not the same value as the Logitech Account Id found when introspecting an OAuth2 Authentication token. Example: 9385e6f9-70c3-45b2-62e4-ace3d027988a. |
accessoryId | string | The Accessory IdAccessory Id - A unique non changing value to identify a particular Accessory. Accessory Id's are globally unique and are UUID v4 strings. A new Accessory Id is assigned by the servers when a device is associated to an account for the first time. If the same physical device is re-associated to the same account, it will receive the same Accessory Id again. If the same physical device is re-associated to a different account, it will receive a new Accessory Id. Example: 70e3e6f9-70c3-45b2-62e4-ace3d027988a. |
name | string | The user assigned friendly name. May contain any unicode compliant character. |
isConnected | boolean | Is the camera connected to the servers. If this value is |
mac | string | The MAC address of the camera. We provide this so you can do a LAN scan via an ARP request to see if the camera is physically present. |
modelNumber | string | The Logitech assigned model number. The value of this field determines the AccessoryAccessory - A unique device within the system. An accessory can be any of type and is represented by a unique Accessory Id. An accessory is linked to an account via an accountId. Within this API, a singular Circle camera is an Accessory. type and what the |
modified | string | A TimestampTimestamp - An ISO8601 based format with everything represented server side as UTC+0 or "zulu" format. Takes the form of YYYY-MM-DDTHH:MM:SSZ - For example: 2015-04-04T00:43:29Z or 2016-05-28T23:12:59Z or 2016-11-04T12:00:00Z formatted string for the last time the AccessoryAccessory - A unique device within the system. An accessory can be any of type and is represented by a unique Accessory Id. An accessory is linked to an account via an accountId. Within this API, a singular Circle camera is an Accessory. was modified. |
features | object | (Optional) An object whose key:value pairs are Service Plan Features. Only present if |
network | object | (Optional) An object which contains the |
configuration | object | A |
CameraConfiguration Sub-Object Fields
To change writable fields use Set Accessory Config by Id.
Name | Type | Mode | Description |
---|---|---|---|
firmwareVersion | string | R | The user visible firmware version string |
timeInSync | boolean | R | Is the camera currently synced to a NTP server. |
timeZone | string | RW | A Linux based timezone string, such as "America/Los_Angeles". Use this to compute the offset from UTC for ActivityActivity - An event that is represented by a start time, end time, relevance and other meta-data. Activities are used to represent videos or audio activity that is part of the same sequence of frames or content. Every Activity has a unique Activity Id. Activities will only be stored for as long your service plan dictates. An Activity belongs to an Accessory. For the full list of attributes on an Activity see Get Activity by Id. Activities can be referred to as "clips" or "recordings" in the Logi Circle application. time display. |
wifiSignalStrength | integer | R | A value from |
batteryLevel | integer | R | A value from |
batteryCharging | boolean | R | Is the battery currently charging. |
horizontalFlip | boolean | R | Circle 1 only. Is horizontal video flip currently enabled. |
verticalFlip | boolean | R | Circle 1 only. Is vertical video flip currently enabled. |
privacyMode | boolean | RW | Is Privacy Mode currently enabled. When Privacy Mode is enabled, live views are allowed, but ActivityActivity - An event that is represented by a start time, end time, relevance and other meta-data. Activities are used to represent videos or audio activity that is part of the same sequence of frames or content. Every Activity has a unique Activity Id. Activities will only be stored for as long your service plan dictates. An Activity belongs to an Accessory. For the full list of attributes on an Activity see Get Activity by Id.
Activities can be referred to as "clips" or "recordings" in the Logi Circle application. recordings and SummarySummary - A video clip that is comprised of one or more Activities with filler data placed between them. Summaries are generated via API calls and have numerous options which govern their creation. A summary is referred to as a "Day Brief" in the Logi Circle application. time-lapse frame generation are disabled. In the Logitech Circle apps, this is referred to as "Recording On/Off" and acts as a logic flip. "Recording On", means |
motionDetection | boolean | RW | Is motion detection enabled. Motion detection is one way an ActivityActivity - An event that is represented by a start time, end time, relevance and other meta-data. Activities are used to represent videos or audio activity that is part of the same sequence of frames or content. Every Activity has a unique Activity Id. Activities will only be stored for as long your service plan dictates. An Activity belongs to an Accessory. For the full list of attributes on an Activity see Get Activity by Id.
Activities can be referred to as "clips" or "recordings" in the Logi Circle application. can be created. Disabling |
pirWakeUp | boolean | R | Can the camera operate in low-power pir Wake Up mode? When this is true, delayed calls are expected as the camera will be in deep sleep mode by default. Circle 2 only. |
powerLineFreq | integer | R | The anti-flicker frequency value to use. |
nightVisionMode | string | RW | The Night Vision mode setting. One of:
|
temperatureIsAvailable | boolean | R | Is there a temperature sensor on the device. |
temperature | float | R | The current temperature in celsius. Changes are only reported in 0.5 degree increments. This field is only valid when |
humidityIsAvailable | boolean | R | Is there a humidity sensor on the device. |
humidity | integer | R | The current partial pressure humidity in the range of |
ledEnabled | boolean | RW | Is the cameras status LED turned on. This only effects the always-on statuses like "connected", "watching", and "privacy mode" colors. The status LED will still flash on booting and in error states. For battery operated cameras this is off by default since it consumes significant amounts of power. |
microphoneOn | boolean | RW | Is audio recording enabled. |
microphoneGain | integer | RW | A value from |
speakerOn | boolean | RW | Is PushToTalk (PTT) enabled. |
speakerVolume | integer | RW | A value form |
streamingEnabled | boolean | RW | Is the Camera Turned On or Off for streaming and recording. This supersedes |
videoSensor | object | R | Circle 2 only. Object which contains the video sensor details. This object describes all the values needed to set the sensor position (aka digital Pan-Tilt-Zoom) in the
|
videoSensorPosition | object | RW | Circle 2 only. Object which contains the current video sensor position (aka viewport, FOV) |
videoStream | object | RW | Object containing: |
webrtcIsAvailable | boolean | R | Is camera-side peer-to-peer WebRTC available when using the Live View API? Server side is always available. |
webrtcEnabled | boolean | RW | Only valid if |
Network Sub-Object Fields
This represents the network configuration object. This object is only present if you have the Permissions scope of circle:accessories_manage.
Name | Type | Description |
---|---|---|
connections | array of | An array of saved network objects. See NetworkConnection definition below |
bleSecKey | string | The BLE security key used to reconfigure network settings in BLE re-configure mode. If this string is empty, then BLE reconfigure mode isn't supported. BLE reconfiguration mode is triggered via Start Accessory Action by Id. |
NetworkConnection Sub-Object Fields
Name | Type | Description |
---|---|---|
connectionName | string | A unique opaque string value to identify this specific entry. The contents of this string will be different on the various hardware models. Do not try to parse this value or assign meaning to its content. |
connected | boolean | Is this active, associated and connected to the Internet |
technology | string | The interface type, one of: |
wifiSsid | string | The WiFi SSID for this connection. Only valid if |
security | string | The type of network security in use for this network, one of:
|