The Collect Data function reads the desired
result registers and sends the data based on the specified settings. This function
works best with continuous conversion mode and does not configure the EVM or
associated register settings. Collect mode starts and stops using the serial COM
port, however the results are sent over the USB BULK channel. To use this mode, use
the following format:
- Start collecting data format: collect timerPeriod collectFlags channelFlags addressIDs numDevices
- Where collect is always lower case, and each parameter is the decimal representation of the value in the following format:
- timerPeriod
- The timer delay used in the MCU to allow data collection sample sets (in µs, unsigned 32-bit value).
- collectFlags (All channels collected together)
- a byte of data that has a 1 to collect and a 0 to not collect each register value type, according to the following definitions:
- VSHUNT = 0b10000
- VBUS = 0b01000
- CURRENT = 0b00100
- POWER = 0b00010
- ENERGY = 0b00001
- channelFlags
- A 4 bit aligned block of data that has a 1 to
collect and a 0 to not collect for each channel,
according to the following definitions:
- Channel 1 = 0b0001
- Channel 2 = 0b0010
- When there are more than 1 EVM, the 4 flag bits of each device are chained together, starting with bits 3 - 0 for EVM 1.
- For example, to collect from Channel 1 and Channel 2 Only for EVM 1 and to collect for Channel 2 only for EVM 2, the value here is 0b00100011
- Note that this is a collect flag only, you need
to make sure the appropriate Channels are enabled in the
register map.
- addressIDs
- This is the 4LSBs of each I2C address chained together, starting with bits 3 - 0.
- For example, if EVM 1 is on address 0x41 and EVM 2 is on 0x43, the value here is 0b00110001
- NumDevices
- The number of EVMs chained together (1-4).
- For example, to start data collection for VSHUNT, VBUS, and POWER every 4.4ms, for two INA2227s with EVM 1 collecting for channels 1 and 2 on address = 0x41 and EVM 2 collecting for channel 2 on address = 0x43, the user needs to send: collect 4400 26 35 49 2
- For this example, the EVM returns the acknowledgment and state in JSON format:
- {"acknowledge":"collect 4400 26 35 49 2"}
- {"evm_state":"collecting"}
- The USB BULK channel receives data in the format: frameID deviceNumID address registerSize data
- Where each parameter is the decimal representation of the value in the following format:
- frameID (1 byte)
- Always reads 0. Used to verify data is aligned.
- deviceNumID (1 byte)
- An ID number corresponding to the EVM number.
- From the above example, this is 1 if reading from EVM 1, which had an address set to 0x41, and 2 if reading from EVM 2 which had an address set to 0x43.
- address (1 byte)
- The register address that is read from the device.
- registerSize (1 byte)
- The number of bytes that the following data has.
- data (1 byte at a time)
- The register data value, given in bytes with the most significant byte first.
- Stop collecting data format: stop
- Where stop is always lower case.
- The EVM returns the acknowledgment and state in JSON format:
- {"acknowledge":"stop"}
- {"evm_state":"idle"}