User Tools

Site Tools


ice:commands:master

Master Board Command Set

List of commands for the ICE Master Board.

#Slave

Arguments:

[Int] BOARD

Example:

#Slave 3 
3


Description

Sets that the Master board will communicate with ICE Slave number BOARD. If BOARD is not specified, returns the ICE Slave number it is currently communicating with.

#Devices

Arguments:

No Arguments Taken

Example:

#Devices  
1: Temp Controller
2: None
...


Description

Shows a list of all connected devices. </div>

#Enumerate

Arguments:

No Arguments Taken

Example:

#Enumerate  
2 1 3 0 0 0 0 0


Description

Returns the device ID's of attached devices in a single line (useful for machine parsing). </div>

#Shutdown

Arguments:

No Arguments Taken

Example:

#Shutdown  
Shutting down...


Description

Fully powers off ICE platform. Restarting requires physical intervention (power button press) by user. </div>

#Sleep

Arguments:

No Arguments Taken

Example:

#Sleep  
Sleeping...


Description

Puts ICE platform into a low power state from which it can be woken via serial connection. All power to attached ICE devices will be turned off during sleep. Note: This isn't currently implemented. </div>

#PowerOn

Arguments:

No Arguments Taken

Example:

#PowerOn  
Sytem Power ON


Description

Enables power to all attached ICE devices. </div>

#PowerOff

Arguments:

No Arguments Taken

Example:

#PowerOff  
System Power OFF


Description

Disables power to all attached ICE devices. All devices are notified before shutdown to perform a safe power off. </div>

#RawMode

Arguments:

[BOOL] ENABLE

Example:

#RawMode T 
ON


Description

Switches command mode into raw mode. Argument is either 'T' for on or 'F' for off. Raw mode disables the use of ASCII command mnemonics, instead using integer command ID's. </div>

#Status

Arguments:

No Arguments Taken

Example:

#Status  
ON


Description

Returns state of power supplies to slave boards as either ON of OFF. </div>

#Version

Arguments:

[Int] ADDRESS

Example:

#Version 2 
6.2 0.0 5.2 5998


Description

If called with no arguments, returns the version information for the master board. If called with an integer argument, will return the version information for the slave board at that address. The format is the version of the PCB, the CPLD firmware, the microcontroller firmware, and finally the serial number of the board. </div>

#Interactive

Arguments:

[BOOL] ENABLE

Example:

#Interactive T 
ON


Description

Switches serial interface between an interactive mode (featuring prompts and local echo) to a programmatic mode. Defaults to programmatic mode (false). </div>

#BulkRead

Arguments:

[Int] BLOCKS

Example:

#BulkRead 1 
f3 e2 14 a4 cc 7d d4 e3


Description

Reads block RAM from current slave. Takes number of blocks to read as an argument. Each block is 8 bytes, returned as hex. The master will return the requested number of bytes (BLOCKS x 8) separated by spaces and then finish with a line return. Requesting a large number of blocks takes processing and I/O time on the bus, so larger requests may take time to return. </div>

#Interlock

Arguments:

[BOOL] ENABLE

Example:

#Interlock T 
ON


Description

Displays status of safety interlock if no argument is given. If master board is set to “OEM” mode by factory, then providing a T/F argument manually sets the interlock state. </div>

#SaveSettings

Arguments:

No Arguments Taken

Example:

#SaveSettings  
SUCCESS


Description

Saves all user settings to non-volatile memory. </div>

#UseInterlock

Arguments:

[BOOL] ENABLE

Example:

#UseInterlock T 
ON


Description

Sets whether the master board should check for interlock state. If set to F (false), then the interlock will always be disabled. This can only be set if OEM mode is on. Otherwise it is a read only command. </div>

#ShadowUSART

Arguments:

[BOOL] ENABLE

Example:

#ShadowUSART T 
ON


Description

If set to T (true), all serial commands on will be echoed on both serial (USB and TTL) interfaces. </div>

#AutoPower

Arguments:

[BOOL] ENABLE

Example:

#AutoPower T 
ON


Description

If set to T (true), then the unit will automatically turn on power to the slave boards after bootup. Otherwise, power to slave boards will remain off but the master board will accept commands. </div>

#UseLCD

Arguments:

[BOOL] ENABLE

Example:

#UseLCD T 
ON


Description

If set the T (true), then the LCD will be used. Otherwise, it will be powered off. </div>

#PauseLCD

Arguments:

[BOOL] ENABLE

Example:

#PauseLCD T 
ON


Description

If set to T (true), then LCD communication will be halted. This is useful to prevent the LCD from consuming I2C bus bandwidth during heavy I/O operations by the user. </div>

ice/commands/master.txt · Last modified: 2019/02/15 12:26 by Michael Radunsky