release

The release command returns previously claimed devices to the unclaimed state. It only succeeds for devices that are claimed by the current API server or are already unclaimed.

See claim for more about the device claiming feature.


Command Type	SDVoE
Minimum Version	3.x.x

Requires the Admin role

Usage

release <target>

Arguments

Argument	Required	Description
`target`	Yes	Device name, MAC address, or device ID of a single device, or a device group. See Targets.

Targets

Value	Releases
`<device>`	A single device
`ALL`	All devices
`ALL_TX`	All transmitter devices
`ALL_RX`	All receiver devices

Changing the claim key

The server's claim key is the device_claim_key value, set via the config command.

Examples

Release a single device
release room_projector

Return value

release is processed asynchronously. The immediate reply is PROCESSING with a request_id. Read the outcome with request.

release room_projector
{
  "status": "PROCESSING",
  "request_id": 42,
  "result": null,
  "error": null
}

Notifications

Releasing devices raises NOTIFICATION messages carrying the devices' updated state. See Notifications.

REST API

Although release originates in the SDVoE API, the REST example below uses a DisplayNet API operation. Use the endpoint shown here. DisplayNet uses it to maintain its own device records.

Endpoint type	DisplayNet API command
Address	`POST /api/displaynet/<operation>`, or name the operation in the body of a `POST /api/displaynet`. See Sending commands.
Role	`Admin`

Operation	Parameters
`release`	`device` `[args]*`

A parameter in brackets is optional. A parameter marked * takes the remainder of the command line as one string. Pass the text exactly as you would type it on the TCI interface.

Usage​

Arguments​

Targets​

Examples​

Return value​

Notifications​

REST API​

See also​