action

Description

Action to execute.

Actions are executed to perform the following regulator operations:

• presence_detection
• configuration
• sensor_monitoring
• phase_fault_detection

Many actions read from or write to a hardware device. Initially this is the device that contains the regulator operation. However, the device can be changed using the set_device action.

Properties

Name	Required	Type	Description
comments	no	array of strings	One or more comment lines describing this action.
and	see notes	array of actions	Action type and.
compare_presence	see notes	compare_presence	Action type compare_presence.
compare_vpd	see notes	compare_vpd	Action type compare_vpd.
i2c_capture_bytes	see notes	i2c_capture_bytes	Action type i2c_capture_bytes.
i2c_compare_bit	see notes	i2c_compare_bit	Action type i2c_compare_bit.
i2c_compare_byte	see notes	i2c_compare_byte	Action type i2c_compare_byte.
i2c_compare_bytes	see notes	i2c_compare_bytes	Action type i2c_compare_bytes.
i2c_write_bit	see notes	i2c_write_bit	Action type i2c_write_bit.
i2c_write_byte	see notes	i2c_write_byte	Action type i2c_write_byte.
i2c_write_bytes	see notes	i2c_write_bytes	Action type i2c_write_bytes.
if	see notes	if	Action type if.
log_phase_fault	see notes	log_phase_fault	Action type log_phase_fault.
not	see notes	action	Action type not.
or	see notes	array of actions	Action type or.
pmbus_read_sensor	see notes	pmbus_read_sensor	Action type pmbus_read_sensor.
pmbus_write_vout_command	see notes	pmbus_write_vout_command	Action type pmbus_write_vout_command.
run_rule	see notes	string	Action type run_rule.
set_device	see notes	string	Action type set_device.

Notes

• You must specify exactly one action type property, such as "i2c_write_byte" or "run_rule".

Return Value

When the action completes, it returns a true or false value. The documentation for the specified action type describes what value will be returned.

Examples

{
  "comments": [ "Set frequency to 800kHz" ],
  "i2c_write_byte": {
    "register": "0x2C",
    "value": "0x0F"
  }
}

{
  "run_rule": "set_voltage_rule"
}