Get full details about a single Accessory Id. 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 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 Id.
accessoryId	string	The Accessory Id.
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 `false` then the camera is offline and not connected to the servers.
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 Accessory type and what the `configuration` object contains. Valid values are: `A1533` - A Circle camera (first generation). `configuration` field is `CameraConfiguration` object. `V-R0008` - A Circle 2 camera (second generation). `configuration` field is `CameraConfiguration` object.
modified	string	A Timestamp formatted string for the last time the Accessory was modified.
features	object	(Optional) An object whose key:value pairs are Service Plan Features. Only present if `features` is included in `extraFields` query param.
network	object	(Optional) An object which contains the `Network` configuration. Only present if you have the circle:accessories_manage permission. This key will be omitted for all others.
configuration	object	A `configuration` object containing Accessory specific fields. The fields within this object are dictated by the `modelNumber` value.

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 Activity time display.
wifiSignalStrength	integer	R	A value from `0` to `100` of the signal strength of the WiFi connection.
batteryLevel	integer	R	A value from `0` to `100` of the batteries charge level if a battery is present or `-1` if no battery is present.
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 Activity recordings and Summary 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 `privacyMode` is `false`. "Recording Off" means `privacyMode` is `true`.
motionDetection	boolean	RW	Is motion detection enabled. Motion detection is one way an Activity can be created. Disabling `motionDetection` will cause no new motion triggered Activities to be created, but the time-lapse frames used for Summaries and manual recordings will still be saved. To fully disable all recordings use `privacyMode`. Use `streamingEnabled` to disable recording and streaming.
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. `0` means automatic country based detection. `50` or `60` means specific hz setting.
nightVisionMode	string	RW	The Night Vision mode setting. One of: `auto` - Night-vision is turned on and off as needed automatically (default) `off` - Night-vision is turned off `on` - Night-vision is turned on
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 `temperatureIsAvailable` is `true`. A value of `-99.0` means no sensor reading is available yet.
humidityIsAvailable	boolean	R	Is there a humidity sensor on the device.
humidity	integer	R	The current partial pressure humidity in the range of `0` to `100`. This field is only valid when `humidityIsAvailable` is `true`. A value of `-1` means no sensor reading is available yet.
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 `0` to `100` for manual microphone gain adjustment.
speakerOn	boolean	RW	Is PushToTalk (PTT) enabled.
speakerVolume	integer	RW	A value form `0` to `100` for the current speaker volume.
streamingEnabled	boolean	RW	Is the Camera Turned On or Off for streaming and recording. This supersedes `privacyMode`
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` field. This contains the following items: `dimensions` - Object containing `width` and `height` integers of the sensor in pixels. `homePosition` - Object containing the default sensor position values of `x`, `y`, `width` and `height`. These values should be used to reset back to the default values. `maxZoomIn` - Object containing `width` and `height` integers of the smallest viewport in pixels the sensor is capable of supporting. This size can be placed at any `x`,`y` offset as long as it is fully contained within the `dimensions` area. `maxZoomOut` - Object containing `width` and `height` integers of the largest viewport in pixels the sensor is capable of supporting. This is typically the same as the `dimensions` object, however some devices have a slightly smaller `maxZoomOut` then `dimensions` due to lens curvature handling.
videoSensorPosition	object	RW	Circle 2 only. Object which contains the current video sensor position (aka viewport, FOV) `x` - The X offset in pixels from the top-left corner of the sensor. Range of `0` to `videoSensor.dimensions.width` `y` - The Y offset in pixels from the top-left corner of the sensor. Range of `0` to `videoSensor.dimensions.height` `width` - The width in pixels to use from the `x`,`y` offset. The width and height specified must use the exact aspect ratio in `videoStream`. `height` - The height in pixels to use from the `x`,`y` offset. The width and height specified must use the exact aspect ratio in `videoStream`.
videoStream	object	RW	Object containing: `width` - Width in pixels `height` - Height in pixels This must be one of: 1920x1080, 1280x720, or 640x360
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 `webrtcIsAvailable` is `true`. This field allows for disabling the camera side WebRTC stack. The server side version is always available.

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 `NetworkConnection` objects	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: `wifi` - Is a WiFi interface. The `wifiSsid` will be a valid string `ethernet` - Is a wired ethernet interface such as from a Power-Over-Ethernet Adapter
wifiSsid	string	The WiFi SSID for this connection. Only valid if `technology` is `wifi`.
security	string	The type of network security in use for this network, one of: `(Empty String)` - No security is required. An unencrypted (open) WiFi network and regular ethernet are this. `psk` - A pre-shared-key is required. An encrypted WiFi with a single password (WPA,WPA2,WPA/WPA2) is this. `unknown` - It isn't known, or the camera firmware doesn't report what security type is in-use.