Entities

Device

A Device represents a single Beam Controller. Each device can has one Door (see below). The attributes of a Device are as follows:

Attribute Name	Data Type	Description
id	UUID	Unique identifier of the Device
number_of_entities_controlled	Integer	DEPRECATED
doors	Object	An object array of Doors (see below)
last_contact	Timestamp (eg. YYYY-MM-DD HH:MM:SS)	Timestamp of the last time the Device reached out to the Beam service
active	Boolean	true if Device is enabled/authorized by Beam, false otherwise
registered	Boolean	true if Device is registered with Beam, false otherwise

Door

A Door represents a single garage door opener connected to a Beam Controller. A Door must belong to a device. The attributes of a device are as follows:

Attribute Name	Data Type	Description
id	UUID	Unique identifier of the Door
image	String	Deprecated
light	Boolean	Deprecated
sensor	Boolean	Deprecated
last_toggled	Timestamp (eg. YYYY-MM-DD HH:MM:SS)	Timestamp of the last time the Device reported a Door state change
name	String	A name assigned by the user. Every user can set their own unique names.
active	Boolean	true if the Door has been registered to a Device, false otherwise
state	Enum	Either “OPEN” or “CLOSED”. Represents current state of door.
user_relationship	String	“Owner” if the current user is the admin of the Device, “Has Access” otherwise (see Permissions)