BrainDevice

Get an object describing the requested command, or null if if the command doesn't exist. This is the same object as returned from BrainDevice#getCommands as the value associated with each command ID.

NOTE: This command is now async, so you must await the result. This is async so we can JIT download the driver instead of downloading every driver for every device in a space.

An example return value from this method would look like:

{
	id: "SET_SYSTEM_USE",
	name: "Set System Use",
	params: { ... },
	states: { ... },
	category: { ... },
	capability: { ... },
}

The params key provides info for you as the programmer to know what params the command expects. See more discussion on this key below. The states, category, and capability keys are internal keys that provide internal config information.

The params object looks like:

{
	...
	POWER: {
		type: 'boolean',
		constraints: { ... },
	},
	SYSTEM: {
		state: { ... },
	},
	...
}

For a params object like the above, you would pass those params to BrainDevice#sendCommand like this:

device.sendCommand(SOME_COMMAND, {
	POWER: 'ON',
	SYSTEM: '50'
})

The above params object example shows two different types of params:

• Dynamic (state-based)
• Static (not state-based)

Dynamic (state-based) params change an associated state, and that state provides type hint info. Whereas static (non state-based) params do not change any states and contain all the type hint info in themselves as shown above.

See the associated examples/command-info.js for a complete example showing how to get the params from the command.

Also see related tutorial: Basics/Sending Commands

Get hash of commands with keys being the ID and the values being the info about the command

NOTE: This command is now async, so you must await the result. This is async so we can JIT download the driver instead of downloading every driver for every device in a space.

Also see related tutorial: Basics/Sending Commands

See BrainDevice#getCommand for documentation on what each command looks like.

Returns an object containing only custom states. If this is not the system device, returns null.

For more information on Custom States, see the "Device States" tutorial.

Gets information about the state, including current value and normalizedValue

Also see related tutorial: Basics/Device States

Get a hash of state IDs => state objects for this device

Also see related tutorial: Basics/Device States

Returns true if this is the system device for this Brain.

The System Device is a virtual device provided internally by the Brain and it provides core services such as time, weather, brain status, custom states, etc. Only the System Device can have custom states.

Remove an event listener from this device. If you pass the STATE_CHANGED event as the event name, the attached BrainClient will automatically unsubscribe from state changes for this device if there are no other event listeners for the STATE_CHANGED event.

This overrides EventEmitter's off function to intercept the event name, but still useses EventEmitter to handle events, so you can use the inheritted on from EventEmitter to start listening for changes again.

Attach an event listener to this device. If you pass the STATE_CHANGED event as the event name, the attached BrainClient will automatically inform the brain to start sending state changes for this device.

Note: The STATE_CHANGED event fires for ALL states on the device. You must filter on the id property of the payload to see if the event represents a change of the state you are interested in.

Related: See notes at the top of this file titled "Listening for State Changes

This overrides EventEmitter's on function to intercept the event name, but still useses EventEmitter to handle events, so you can use the inheritted off from EventEmitter to stop listening for changes.

Execute command and return any changed states.

Example Usage

device.sendCommand('SEND_SYSTEM_USE', {
	SYSTEM_STATE: 'ON'
});

Also see the related tutorial: Basics/Sending Commands

Set a custom state to a given value

NOTE: The concept of "Custom States" (and hence, this method) is only relevant on the System Device (BrainDevice#isSystemDevice must return true) otherwise calling this method will throw an error.

For more information on device states and custom states, see the Basics/Device States tutorial.