System Entity¶

group SystemEntity: SystemClass: The System class provides access to the core settings, configuration and system information of the BrainStem module. The class provides access to the model type, serial number and other static information as well as the ability to set boot reflexes, toggle the user LED, as well as affect module and router addresses etc. The most common brainstem example uses the system entity to blink the User LED.

void system_getModule(unsigned int *id, struct Result *result)¶

Get the current address the module uses on the BrainStem network.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getModuleBaseAddress(unsigned int *id, struct Result *result)¶

Get the base address of the module. Software offsets and hardware offsets are added to this base address to produce the effective module address.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_setRouter(unsigned int *id, struct Result *result, const unsigned char address)¶

Set the router address the module uses to communicate with the host and heartbeat to in order to establish the BrainStem network. This setting must be saved and the board reset before the setting becomes active. Warning: changing the router address may cause the module to “drop off” the BrainStem network if the new router address is not in use by a BrainStem module. Please review the BrainStem network fundamentals before modifying the router address.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.
address – The router address to be used.

Returns:

Returns common entity return values

void system_getRouter(unsigned int *id, struct Result *result)¶

Get the router address the module uses to communicate with the host and heartbeat to in order to establish the BrainStem network.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_setHBInterval(unsigned int *id, struct Result *result, const unsigned char interval)¶

Set the delay between heartbeat packets which are sent from the module. For link modules, these these heartbeat are sent to the host. For non-link modules, these heartbeats are sent to the router address. Interval values are in 25.6 millisecond increments Valid values are 1-255; default is 10 (256 milliseconds).

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.
interval – The desired heartbeat delay.

Returns:

Returns common entity return values

void system_getHBInterval(unsigned int *id, struct Result *result)¶

Get the delay between heartbeat packets which are sent from the module. For link modules, these these heartbeat are sent to the host. For non-link modules, these heartbeats are sent to the router address. Interval values are in 25.6 millisecond increments.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_setLED(unsigned int *id, struct Result *result, const unsigned char bOn)¶

Set the system LED state. Most modules have a blue system LED. Refer to the module datasheet for details on the system LED location and color.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.
bOn – true: turn the LED on, false: turn LED off.

Returns:

Returns common entity return values

void system_getLED(unsigned int *id, struct Result *result)¶

Get the system LED state. Most modules have a blue system LED. Refer to the module datasheet for details on the system LED location and color.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_setBootSlot(unsigned int *id, struct Result *result, const unsigned char slot)¶

Set a store slot to be mapped when the module boots. The boot slot will be mapped after the module boots from powers up, receives a reset signal on its reset input, or is issued a software reset command. Set the slot to 255 to disable mapping on boot.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.
slot – The slot number in aSTORE_INTERNAL to be marked as a boot slot.

Returns:

Returns common entity return values

void system_getBootSlot(unsigned int *id, struct Result *result)¶

Get the store slot which is mapped when the module boots.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getVersion(unsigned int *id, struct Result *result)¶

Get the modules firmware version number. The version number is packed into the return value. Utility functions in the aVersion module can unpack the major, minor and patch numbers from the version number which looks like M.m.p.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

void system_getModel(unsigned int *id, struct Result *result)¶

Get the module’s model enumeration. A subset of the possible model enumerations is defined in BrainStem.h under “BrainStem model codes”. Other codes are be used by Acroname for proprietary module types.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getHardwareVersion(unsigned int *id, struct Result *result)¶

Get the module’s hardware revision information. The content of the hardware version is specific to each Acroname product and used to indicate behavioral differences between product revisions. The codes are not well defined and may change at any time.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getSerialNumber(unsigned int *id, struct Result *result)¶

Get the module’s serial number. The serial number is a unique 32bit integer which is usually communicated in hexadecimal format.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_save(unsigned int *id, struct Result *result)¶

Save the system operating parameters to the persistent module flash memory. Operating parameters stored in the system flash will be loaded after the module reboots. Operating parameters include: heartbeat interval, module address, module router address

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_reset(unsigned int *id, struct Result *result)¶

Reset the system. aErrTimeout indicates a successful reset, as the system resets immediately, which tears down the USB-link immediately, thus preventing an affirmative response.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_logEvents(unsigned int *id, struct Result *result)¶

Saves system log events to a slot defined by the module (usually ram slot 0).

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getUptime(unsigned int *id, struct Result *result)¶

Get the module’s accumulated uptime in minutes

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getTemperature(unsigned int *id, struct Result *result)¶

Get the module’s current temperature in micro-C

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getMinimumTemperature(unsigned int *id, struct Result *result)¶

Get the module’s minimum temperature ever recorded in micro-C (uC) This value will persists through a power cycle.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getMaximumTemperature(unsigned int *id, struct Result *result)¶

Get the module’s maximum temperature ever recorded in micro-C (uC) This value will persists through a power cycle.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getInputVoltage(unsigned int *id, struct Result *result)¶

Get the module’s input voltage.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getInputCurrent(unsigned int *id, struct Result *result)¶

Get the module’s input current.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getModuleHardwareOffset(unsigned int *id, struct Result *result)¶

Get the module hardware address offset. This is added to the base address to allow the module address to be configured in hardware. Not all modules support the hardware module address offset. Refer to the module datasheet.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_setModuleSoftwareOffset(unsigned int *id, struct Result *result, const unsigned char address)¶

Set the software address offset. This software offset is added to the module base address, and potentially a module hardware address to produce the final module address. You must save the system settings and restart for this to take effect. Please review the BrainStem network fundamentals before modifying the module address.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.
address – The address for the module. Value must be even from 0-254.

Returns:

Returns common entity return values

void system_getModuleSoftwareOffset(unsigned int *id, struct Result *result)¶

Get the software address offset. This software offset is added to the module base address, and potentially a module hardware address to produce the final module address. You must save the system settings and restart for this to take effect. Please review the BrainStem network fundamentals before modifying the module address.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getRouterAddressSetting(unsigned int *id, struct Result *result)¶

Get the router address system setting. This setting may not be the same as the current router address if the router setting was set and saved but no reset has occurred. Please review the BrainStem network fundamentals before modifying the module address.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_routeToMe(unsigned int *id, struct Result *result, const unsigned char bOn)¶

Enables/Disables the route to me function. This function allows for easy networking of BrainStem modules. Enabling (1) this function will send an I2C General Call to all devices on the network and request that they change their router address to the of the calling device. Disabling (0) will cause all devices on the BrainStem network to revert to their default address.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.
bOn – Enable or disable of the route to me function 1 = enable.

Returns:

Returns common entity return values

void system_getPowerLimit(unsigned int *id, struct Result *result)¶

Reports the amount of power the system has access to and thus how much power can be budgeted to sinking devices.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

void system_getPowerLimitMax(unsigned int *id, struct Result *result)¶

Gets the user defined maximum power limit for the system. Provides mechanism for defining an unregulated power supplies capability.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_setPowerLimitMax(unsigned int *id, struct Result *result, const unsigned int power)¶

Sets a user defined maximum power limit for the system. Provides mechanism for defining an unregulated power supplies capability.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.
power – Limit in milli-Watts (mW) to be set.

Returns:

Returns common entity return values

void system_getPowerLimitState(unsigned int *id, struct Result *result)¶

Gets a bit mapped representation of the factors contributing to the power limit. Active limit can be found through PowerDeliverClass::getPowerLimit().

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getUnregulatedVoltage(unsigned int *id, struct Result *result)¶

Gets the voltage present at the unregulated port.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getUnregulatedCurrent(unsigned int *id, struct Result *result)¶

Gets the current passing through the unregulated port.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getInputPowerSource(unsigned int *id, struct Result *result)¶

Provides the source of the current power source in use.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getInputPowerBehavior(unsigned int *id, struct Result *result)¶

Gets the systems input power behavior. This behavior refers to where the device sources its power from and what happens if that power source goes away.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_setInputPowerBehavior(unsigned int *id, struct Result *result, const unsigned char behavior)¶

Sets the systems input power behavior. This behavior refers to where the device sources its power from and what happens if that power source goes away.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.
behavior – An enumerated representation of behavior to be set.

Returns:

Returns common entity return values

void system_getInputPowerBehaviorConfig(unsigned int *id, struct Result *result, unsigned int *buffer, const int bufferLength)¶

Gets the input power behavior configuration Certain behaviors use a list of ports to determine priority when budgeting power.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.
buffer – pointer to the start of a c style buffer to be filled
bufLength – Length of the buffer to be filed
unloadLength – Length that was actually received and filled.

Returns:

Returns common entity return values

void system_setInputPowerBehaviorConfig(unsigned int *id, struct Result *result, const unsigned int bufLength)¶

Sets the input power behavior configuration Certain behaviors use a list of ports to determine priority when budgeting power.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.
bufLength – Length of the buffer to be transferred.

Returns:

Returns common entity return values

void system_getName(unsigned int *id, struct Result *result, unsigned char *buffer, const int bufferLength)¶

Gets a user defined name of the device. Helpful for identifying ports/devices in a static environment.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.
buffer – pointer to the start of a c style buffer to be filled
bufLength – Length of the buffer to be filed
unloadLength – Length that was actually received and filled.

Returns:

Returns common entity return values

void system_setName(unsigned int *id, struct Result *result, unsigned char *buffer, const int bufferLength)¶

Sets a user defined name for the device. Helpful for identification when multiple devices of the same type are present in a system.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.
buffer – Pointer to the start of a c style buffer to be transferred.
bufLength – Length of the buffer to be transferred.

Returns:

Returns common entity return values

void system_resetEntityToFactoryDefaults(unsigned int *id, struct Result *result)¶

Resets the SystemClass Entity to it factory default configuration.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_resetDeviceToFactoryDefaults(unsigned int *id, struct Result *result)¶

Resets the device to it factory default configuration.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_getLinkInterface(unsigned int *id, struct Result *result)¶

Gets the link interface configuration. This refers to which interface is being used for control by the device.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values

void system_setLinkInterface(unsigned int *id, struct Result *result, const unsigned char linkInterface)¶

Sets the link interface configuration. This refers to which interface is being used for control by the device.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone on success. Non-zero error code on failure.
linkInterface – An enumerated representation of interface to be set.
- 0 = Auto= systemLinkAuto
- 1 = Control Port = systemLinkUSBControl
- 2 = Hub Upstream Port = systemLinkUSBHub

Returns:

Returns common entity return values

void system_getErrors(unsigned int *id, struct Result *result)¶

Gets any system level errors. Calling this function will clear the current errors. If the error persists it will be set again.

Parameters:

id – The id assigned by the create stem vi.
result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

Returns:

Returns common entity return values