unlock

The unlock command returns one or more previously locked devices to the unlocked state, allowing configuration and routing changes again. It is the inverse of lock.

unlock is a convenience alias over the dev.Locked device configuration item: unlocking a device deletes the dev.Locked setting (restoring the default), equivalent to config delete <device> dev.Locked. Clients receive the same configurations notification produced by the config command.

info

Unlocking is idempotent: unlocking an already-unlocked device succeeds without making a change or emitting a notification.

Command Type	DisplayNet
Minimum Version	4.6

Usage

unlock <target>

Arguments

target is a single device ID, a comma-separated list of device IDs, or a device group:

Value	Unlocks
<device_id>	A single device
ALL	All devices
ALL_TX	All transmitter devices
ALL_RX	All receiver devices

With a group or a list, each resolvable device is processed independently and the result reports the outcome per device.

State and side effects

• The stored lock is removed, not set to false. A device that has never been locked and a device that has been unlocked are indistinguishable.
• Everything lock was refusing becomes possible again immediately, for every client on every transport.

Notifications

Unlocking devices that change state raises NOTIFICATION messages carrying the updated device configuration. See Requests and Events for more information.

Return value

The result contains a lock array with one entry per processed device. Each entry reports the device's actual locked state after the operation and a status of unlocked (state changed), unchanged (already unlocked), or skipped (the change could not be applied).

unlock room_projector
{
   "status" : "SUCCESS",
   "request_id" : null,
   "result" : {
      "lock" : [
         { "device_id" : "001ec0f04d9c", "locked" : false, "status" : "unlocked" }
      ]
   },
   "error" : null
}

REST API

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	User

Operation	Parameters
unlock	targets

See also

• lock: the inverse, and what a lock refuses
• config: the dev.Locked setting this is an alias over