BrainInfo

BrainInfo

BrainInfo describes the fields from the 'general' API route for the brain.

You can access an instance of this class containing the following properties by awaiting BrainClient#brainInfo.

You'll never need to create this directly, this is simply included for documentation purposes.

Constructor

new BrainInfo()

Properties
brain_id:string

ID of the brain

brain_provisioned:boolean

True if the brain is provisioned to a space

brain_reset_data_dir:number

One of: 0 = off, 1 = on

brain_state:string

String describing the current brain state

brain_status_color:string

Color code for the status of the brain

brain_status_reason:string

String describing the reason for the state/color

brain_sync_on_wan_restore:number

One of: 0=off, 1=always sync on wan restore, 2=sync on wan restore only if timestamps of published space and cached data have changed

brain_version:string

version of the software running on the physical Brain unit

hardware_mac:string

MAC address of the Brain hardware

hardware_model:string

Model number of the Brain hardware

hardware_serial_number:string

Serial number of the Brain hardware

hardware_version:string

Version of the Brain hardware

last_publish_date:string

Date of the last publish for the space provisioned to the Brain

last_synced_date:string

Date of the last time the brain sync'd it's cache with the cloud

project_id:string

Project ID of the Kramer Control Project provisioned to this brain

project_name:string

Project Name of the Kramer Control Project provisioned to this brain

project_time:string

Project Time of the Kramer Control Project provisioned to this brain

space_id:string

Space ID of the Kramer Control Space provisioned to this brain

space_name:string

Space Name of the Kramer Control Space provisioned to this brain

sys_state:Object

Object containing a summary of the brain state

Source: BrainInfo.js, line 35