Writes and reads various configuration settings associated with the Comm processor.

If WriteMask is nonzero, some or all default values are written to flash. The Comm flash has a rated endurance of at least 20000 writes, which is plenty for reasonable operation, but if this function is called in a high-speed loop with a nonzero WriteMask, the flash could eventually be damaged.

There is a hardware method to restore parameters to the default values described below (in parentheses). Power up the UE9 with a short from FIO2<=>SCL, then remove the jumper and power cycle the device again. This also returns Control settings to factory defaults (Sections 5.3.2 and 5.3.13).

Table 5.2.1-1. Read and write commands

• WriteMask: See general protocol description in Section 5.1.
• LocalID: (1) Used by higher-level functions to identify a specific LabJack.
• PowerLevel: (0) Not implemented.
• IPAddress: (192.168.1.209) The value returned by this parameter is the current IPAddress. If you write a new IPAddress, it will not take effect until after a reset, so you will not immediately read back the new address.
• Gateway: (192.168.1.1) Reset required for a change to take effect.
• Subnet: (255.255.255.0) Reset required for a change to take effect.
• PortA: (52360) Normal TCP/UDP port. Reset required for a change to take effect. Note that bit 5 of WriteMask affects PortA and PortB.
• PortB: (52361) Secondary TCP port. Reset required for a change to take effect. Only used to send stream data from the UE9 to the host.
• DHCPEnabled: (0) A value of 1 means that DHCP is enabled. Reset required for a change to take effect.
• ProductID: (9) Fixed parameter identifies this LabJack as a UE9.
• MACAddress: Fixed parameter. To determine the 4-byte serial number, add hex 10.0.0.0 to the lower 3 bytes of the MAC.
• HWVersion: Fixed parameter specifies the version number of the electronics hardware. The lower byte is the integer portion of the version and the higher byte is the fractional portion of the version.
• CommFWVersion: Fixed parameter specifies the version number of the Comm firmware. A firmware upgrade will generally cause this parameter to change. The lower byte is the integer portion of the version and the higher byte is the fractional portion of the version.

Resets the pointers to the stream buffer to make it empty. Often called before a stream, after a stream, or both.

Table 5.2.2-1. FlushBuffer Command/response

This is a special function only used over Ethernet UDP. Send the 6-byte command below to port 52362, using the broadcast IP of 255.255.255.255. The command will try to go to every device on the subnet, and every Ethernet LabJack should send back the specified 38 byte response.

The response is similar to the response from the CommConfig function. See Section 5.2.1 for additional documentation.

DiscoveryUDP and the standard Ping function are useful for finding Ethernet connected UE9s and testing basic communication.

Table 5.2.3-1.

Sets a list of up to five IP addresses that are the only IP addresses that can connect to the UE9. Any unused Addresses can be set to 0xFFFFFFFF (255.255.255.255). If IP #0 is set to 0xFFFFFFFF than the feature is disabled and any IP address can connect.

Table 5.2.4-1.

• Write: Set to non-zero if new values should be updated. Pass 0×00 if only reading. A value of non-zero will only work if the command is sent via USB.
• IP #0: First IP address allowed to connect. A value of 0xFFFFFFFF disables feature.
• IP #1: Second IP address allowed to connect.
• IP #2: Third IP address allowed to connect.
• IP #3: Fourth IP address allowed to connect.
• IP #4: Fifth IP address allowed to connect.

Configures various parameters associated with the Control processor. Although this function appears to have many of the same digital I/O and DAC parameters as other functions, most parameters in this case are affecting the power-up values, not the current values.

If WriteMask is nonzero, some or all default values are written to flash. The Control flash has a rated endurance of at least 20000 writes, which is plenty for reasonable operation, but if this function is called in a high-speed loop with a nonzero WriteMask, the flash could be damaged.

There is a hardware method to restore parameters to the default values described below (in parentheses). Power up the UE9 with a short from FIO2<=>SCL, then remove the jumper and power cycle the device again. This also returns Comm (Section 5.2.1) and Watchdog (Section 5.3.13) settings to factory defaults.

Note: If the stream is running, you cannot update any of the values (WriteMask must equal 0).

Table 5.3.2-1. ControlConfig Command/Response

• PowerLevel: (0) At this time low speed is not supported. The resulting heating and cooling of the processor causes analog calibration problems. Intended operation: Specifies different system clock speeds for the Control processor. Streaming does not work at fixed low speed. The WriteMask behaves differently for this parameter. The value passed for PowerLevel always becomes the current operating condition. If the WriteMask bit 0 is set, the value passed becomes the current value and the default value, meaning it is written to flash and used at reset. The return value of this parameter is a read of the power-up default.
• FIO/EIO/CIO/MIO: (0) If the WriteMask bit 1 is set, the values passed become the default values, meaning they are written to flash and used at reset. Regardless of the mask bit, this function has no effect on the current settings. These defaults are only used if bit 8 of MIODirState is clear. The return value of this parameter is a read of the power-up defaults.
• DAC#: (0) If the WriteMask bit 2 is set, the values passed become the default values, meaning they are written to flash and used at reset. Regardless of the mask bit, this function has no effect on the current settings. The return value of this parameter is a read of the power-up defaults.
• ControlFWVersion: Fixed parameter specifies the version number of the Control firmware. A firmware upgrade will generally cause this parameter to change.

A very useful function that writes/reads almost every I/O on the LabJack UE9.

Note: Feedback command should not be called while streaming. FeedbackAlt with no analog inputs is allowed.

Table 5.3.3-1. Feedback Command Response

• IOMask: Mask each bit of digital I/O individually. If a bit is 1, then the new direction and state values will be written to that bit of I/O. If a bit is 0, only a read of state and direction will be done.
• IODir: 0 is input, and 1 is output.
• IOState: As a write parameter, only has an effect if a line is set to output. For each bit, 0 is output-low, and 1 is output-high. As a read parameter, it returns the current input state of each line where 0 is low and 1 is high.
• DAC#: The UE9 has 12-bit analog outputs, so pass an output value between 0 and 4095, plus set bits 6 and 7 of the high byte accordingly. Bit 6 specifies whether the given DAC will be updated with the new value. If Bit7 is set on either DAC, then both are enabled. To disable the DACs (set to high-impedance), bit 7 must be 0 for both DACs.
• AINMask: If a bit is 0, the corresponding channel will not be acquired (saving time), and will return 0 as a reading.
• AIN14/15ChannelNumber: Generally used to choose one of the internal channels, but any channel can be used.
• Resolution: Determines the resolution setting for all analog inputs (12-17). See Sections 2.7, 3.1, and 3.2. This function does not support the high-resolution converter on the UE9-Pro.
• SettlingTime: Adds extra settling time before acquiring each channel. The extra delay is this value multiplied by about 5 microseconds.
• BipGain: Contains the bipolar setting and gain options for two analog input channels. The high nibble controls the higher channel number. The high bit of each nibble is the bipolar option and the lower 3 bits of each nibble are the gain index. Following are the nibble values for various gains:

Table 5.3.3-2. Nibble values for various gains

• AIN#: Returns raw analog input conversions. Regardless of Resolution, the value returned is 0-65520, where 0 is the minimum (unsigned, not 2’s complement).
• Counter#: Returns the current count from the counters if enabled. Use the function TimerCounter to enable and configure the counters.
• Timer#: Returns the values from the first 3 enabled timer modules. Use the function TimerCounter to enable and configure the timer modules.

The LabJackUD driver for Windows uses a modified version of the Feedback function called FeedbackAlt. This modified function has additional parameters added to specify channel numbers for all 16 analog input reads, making it useful when using extended channels or more than 2 internal channels.

The command for FeedbackAlt is the same as Feedback, except that AINxChannelNumber parameters are added for channels 0-13 (new bytes 34-47). The command number (byte 3) changes to 0x01 and the number of data words (byte 2) changes to 0x15.

The response for FeedbackAlt is the same as Feedback, except that the counter/timer reads are removed, and thus the response is 44 bytes long. The command number (byte 3) changes to 0x01 and the number of data words (byte 2) changes to 0x13.

The order of execution in hardware for either function is:

1. Write digital I/O.
2. Read digital I/O.
3. Write analog outputs.
4. Read analog inputs.
5. Read timers and counters (skipped in FeedbackAlt).

An alternative to Feedback, is this function which writes or reads a single output or input.

Note: Do not use SingleIO with the AIN IOType while streaming.

Table 5.3.4-1. SingleIO Command Response

• IOType: Specifies the I/O to write or read. The digital read types are used to read the state and direction of digital I/O. The digital write types are used to configure digital I/O to one of three states: input, output-low, or output-high.

Table 5.3.4-2. IOType

• Channel: Specifies which channel of IOType to write or read. For the digital port IOTypes (2 & 3) use the following table.

Table 5.3.4-3. Channel of IOType

• Dir/BipGain/DACL: For a digital bit write, this is 0 for input, and 1 for output. For a digital port write, this is multiple bits specifying input or output for each line. Ignored for digital reads. For an analog input this is the BipGain parameter (see Feedback). For an analog output this is the low byte of the binary output value.
• State/Resolution/DACH: For a digital bit write, this is the output state. For a digital port write, this is multiple bits specifying the output state for each line. Ignored for digital reads. For an analog input this is the Resolution parameter (12-18). For an analog output this is the most significant 4 bits of the binary output value, and the upper 4 bits are ignored as the output is always updated and IOType=5 causes both DACs to be enabled.
• SettlingTime: Only applies to analog inputs (see Feedback).
• Dir/AINL: For a digital bit read, this reads 0 for input, and 1 for output. For a digital port read, this is multiple bits returning input or output for each line. For digital writes this is just an echo. For an analog input this is the lowest 8 bits of the 24-bit conversion value (generally ignored on the UE9).
• State/AINM: For a digital bit read, this is a read of the input state. For a digital port read, this is multiple bits returning a read of the input state for each line. For digital writes this is just an echo. For an analog input this is the middle 8 bits of the 24-bit conversion value, or more typically considered the lowest 8 bits of the 16-bit conversion value.
• AINH: For an analog input this is the high 8 bits of the 24-bit conversion value, or more typically considered the high 8 bits of the 16-bit conversion value. Binary readings are always unsigned integers.

Enables, configures, and reads the counters and timers.

Table 5.3.5-1. TimerCounter Command Response

• EnableMask: If the UpdateConfig bit is 0, this parameter and the TimerClock parameters do nothing. If the UpdateConfig bit is 1, then the timers and counters are enabled and disabled as specified by the other bits. The lower 3 bits specify the number of timers enabled (0-6). Bits 3 and 4 are set to enable a counter, or cleared to disable a counter. Any enabled timers and counters will take over FIO lines in order, starting with FIO0. Counter1 is used internally by stream mode, but in such a case only uses an FIO line if master or slave stream mode is used. The counters are reset when enabled or disabled.
• EnableStatus: Returns which timers and counters are enabled. Bit locations are the same as the UpdateReset byte.
• TimerClockBase: The determines the timer base clock which is used by all output mode timers. The choices are a fixed 750 kHz clock source, or the system clock. The UE9 is by default in high power mode which means the system clock is fixed at 48 MHz. The UpdateConfig bit must be set to change this parameter.
• TimerClockDivisor: The timer clock is divided by this value, or divided by 256 if this value is 0. The UpdateConfig bit must be set to change this parameter.
• UpdateReset: Each bit of this parameter determines whether that timer or counter is set to a new value or reset. Reads are performed before reset.
• Timer#Mode: These values are only updated if the UpdateConfig bit is set. Following are the values to pass to configure how a timer operates:

Table 5.3.5-2. Timer Modes

• Timer#Value: These values are only updated if the UpdateConfig or associated UpdateReset bit is 1. The meaning of this parameter varies with the timer mode. See Section 2.10 for further information.
• Counter#Mode: Pass 0.
• Timer#: Returns the values from the timer modules. This is the value before reset (if reset was done).
• Counter#: Returns the current count from the counters if enabled. This is the value before reset (if reset was done).

Not supported over UDP. Once the stream settings are configured, this function is called to start the stream.

Table 5.3.7-1. StreamStart Command Response

Not supported over UDP. After starting the stream, the data will be sent as available in the following format. Data is sent 16 samples at a time in a 46 byte packet. Reads oldest data from buffer.

Note that USB stream data is a special case where each 46-byte data packet is padded with 2 zeros on the end (not part of the protocol), and then 4 of these 48-byte blocks are grouped together and sent in 3 transfers over the 64-byte endpoint. See the USB Section for more information.

Table 5.3.8-1. StreamData response table

• TimeStamp: Reserved.
• PacketCounter: An 8-bit (0-255) counter that is incremented by one for each packet of data. Useful to make sure packets are in order and no packets are missing.
  Sample#: Stream data is placed in a FIFO (first in first out) buffer, so Sample0 is the oldest data read from the buffer and Sample15 is the 16th oldest sample. This stream data packet always returns 16 samples regardless of the number of channels in the scan list.
• ControlBacklog: When streaming, the Control processor acquires data at precise intervals, and transfers it to the Comm processor which has a large data buffer. The Control processor has a small data buffer (256 samples) for data waiting to be transferred to the Comm processor, and this ControlBacklog parameter specifies the number of samples remaining in the Control buffer. If this parameter is nonzero and growing, it suggests that the Control processor is too busy.
• CommBacklog: The Comm processor holds stream data in a 4 Mbit FIFO buffer (512 Kbytes, 11397 StreamData packets, 182361 samples) until it can be sent to the host. The lower 7 bits of CommBacklog specifies how much data is left in the buffer in increments of 4096 bytes. The MSb of CommBacklog is set on buffer overflow, but in such a case the lower 7 bits still specify the amount of valid data (before overflow) in the buffer.

Not supported over UDP.

Table 5.3.9-1. StreamStop Command Response

Reads 1 block (128 bytes) from the Control non-volatile memory. The Mem area is arranged in 16 blocks of 128 bytes each. Blocks 0-7 are used by LabJack Corporation to store calibration data, and blocks 8-15 are available to the user.

Table 5.3.10-1. ReadMem Command Response

Writes 1 block (128 bytes) to the Control non-volatile memory. The Mem area must be erased before writing. The Mem area is arranged in 16 blocks of 128 bytes each. Blocks 0-7 are used by LabJack Corporation to store calibration data, and blocks 8-15 are available to the user.

Table 5.3.11-1. WriteMem Command Response

The UE9 uses flash memory, so you must erase it before writing. The non-volatile Mem area is arranged in 16 blocks of 128 bytes each. Blocks 0-7 are used by LabJack Corporation to store calibration data, and blocks 8-15 are available to the user. The EraseMem function erases 1 Kbyte at a time (blocks 0-7 or blocks 8-15). There is no way to erase only a smaller area.

Table 5.3.12-1. EraseMem Command Response

Controls a firmware based watchdog timer. Unattended systems requiring maximum up-time might use this capability to reset the UE9 or the entire system. When any of the options are enabled, an internal timer is enabled which resets on any incoming Control communication. If this timer reaches the defined TimeoutPeriod before being reset, the specified actions will occur. Note that while streaming, data is only going out of the Control processor, so some other Control command will have to be called periodically to reset the watchdog timer.

If the watchdog is accidentally configured to reset the processors with a very low timeout period (such as 1 second), it could be difficult to establish any communication with the device. In such a case, the reset-to-default jumper can be used to turn off the watchdog (sets bytes 7-10 to 0). Power up the UE9 with a short from FIO2<=>SCL, then remove the jumper and power cycle the device again. This also returns Comm (Section 5.2.1) and Control (Section 5.3.2) settings to factory defaults.

The watchdog settings (bytes 7-10) are stored in non-volatile flash memory, so every call to this function where settings are changed causes a flash erase/write. The Control flash has a rated endurance of at least 20000 writes, which is plenty for reasonable operation, but if this function is called in a high-speed loop the flash could be damaged.

Note: Do not call this function while streaming.

Table 5.3.13.1-1. WatchdogConfig Command Response

• WatchdogOptions: The watchdog is enabled when this byte is nonzero. Set the appropriate bit to reset either or both processors, update the state of 1 or 2 digital I/O, or update 1 or both DACs.
• TimeoutPeriod: The watchdog timer is reset to zero on any incoming Control communication. Note that most functions consist of a write and read, but StreamData is outgoing only and does not reset the watchdog. If the watchdog timer is not reset before it counts up to TimeoutPeriod, the actions specified by WatchdogOptions will occur. The watchdog timer has a clock rate of about 1 Hz, so a TimeoutPeriod range of 1-65535 corresponds to about 1 to 65535 seconds.
• DIOConfig#: Determines which digital I/O is affected by the watchdog, and the state it is set to. The digital I/O # is a value from 0-22 according to the following: 0-7 => FIO0-FIO7, 8-15 => EIO0-EIO7, 16-19 => CIO0-CIO3, 20-22 => MIO0-MIO2
• DAC#: Specifies values for the DACs on watchdog timeout. The UE9 has 12-bit analog outputs, so pass an output value between 0 and 4095, plus set bit 7 of the high byte accordingly. If Bit7 is set on either DAC, then both are enabled. To disable the DACs (set to high-impedance), bit 7 must be 0 for both DACs.

Reads the current watchdog settings.

Table 5.3.13.2-1. WatchdogRead Command Response

Controls a firmware based watchdog timer. Unattended systems requiring maximum up-time might use this capability to reset the UE9 or the entire system. When any of the options are enabled, an internal timer is enabled which resets on any incoming Control communication. If this timer reaches the defined TimeoutPeriod before being reset, the specified actions will occur. Note that while streaming, data is only going out of the Control processor, so some other Control command will have to be called periodically to reset the watchdog timer.

If the watchdog is accidentally configured to reset the processors with a very low timeout period (such as 1 second), it could be difficult to establish any communication with the device. In such a case, the reset-to-default jumper can be used to turn off the watchdog (sets bytes 7-10 to 0). Power up the UE9 with a short from FIO2<=>SCL, then remove the jumper and power cycle the device again. This also returns Comm (Section 5.2.1) and Control (Section 5.3.2) settings to factory defaults.

The watchdog settings (bytes 7-10) are stored in non-volatile flash memory, so every call to this function where settings are changed causes a flash erase/write. The Control flash has a rated endurance of at least 20000 writes, which is plenty for reasonable operation, but if this function is called in a high-speed loop the flash could be damaged.

New features in the extended version:

• Initial roll time: When the UE9 resets a longer timeout will be used. Once the watchdog has been reset the normal roll time will be used.
• Strict: Allow a specific key to be specified, so that only calling the WDT_Clear function with the matching key will reset the WatchDog.

Table 5.3.13.3-1. Extended WatchdogConfig Command Response

WatchdogOptions: The watchdog is enabled when this byte is nonzero. Set the appropriate bit to reset either or both processors, update the state of 1 or 2 digital I/O, or update 1 or both DACs.

TimeoutPeriod: The watchdog timer is reset to zero on any incoming Control communication. Note that most functions consist of a write and read, but StreamData is outgoing only and does not reset the watchdog. If the watchdog timer is not reset before it counts up to TimeoutPeriod, the actions specified by WatchdogOptions will occur. The watchdog timer has a clock rate of about 1 Hz, so a TimeoutPeriod range of 1-65535 corresponds to about 1 to 65535 seconds.

Initial TimeoutPeriod: Timeout period that will be used until the first WatchDog clear. 

DIOConfig#: Determines which digital I/O is affected by the watchdog, and the state it is set to. The digital I/O # is a value from 0-22 according to the following: 0-7 => FIO0-FIO7, 8-15 => EIO0-EIO7, 16-19 => CIO0-CIO3, 20-22 => MIO0-MIO2

DAC#: Specifies values for the DACs on watchdog timeout. The UE9 has 12-bit analog outputs, so pass an output value between 0 and 4095, plus set bit 7 of the high byte accordingly. If Bit7 is set on either DAC, then both are enabled. To disable the DACs (set to high-impedance), bit 7 must be 0 for both DACs.

Strict Key: Specifies a 1 byte key that must be passed to WatchDog Clear if strict is enabled.

When the Watchdog is operating in strict mode this is the only function that will reset the Watchdog timer.

This function will return an error if the watchdog is not in strict mode or if the key does not match.

Table 5.3.13.4-1. WatchdogClear Command Response

Control command causes a soft or hard reset. Affects both processors.

Table 5.3.15-1. Reset command response

Control command sends and receives serial data using SPI synchronous communication.

Table 5.3.16-1. SPI Command Response

• NumSPIWords: This is the number of SPI bytes divided by 2. If the number of SPI bytes is odd, round up and add an extra zero to the packet.
• SPIOptions: If AutoCS is true, the CS line is automatically driven low during the SPI communication and brought back high when done. If DisableDirConfig is true, this function does not set the direction of the lines, whereas if it is false the lines are configured as CS=output, CLK=output, MISO=input, and MOSI=output. SPIMode specifies the standard SPI mode as discussed below.
• SPIClockFactor: Sets the frequency of the SPI clock according the following approximate formula: Frequency = 1000000/(8+10*(256-SPIClockFactor), where passing a value of 0 corresponds to a factor of 256, and thus a maximum frequency of about 125 kHz.
• CS/CLK/MISO/MOSI -PinNum: Assigns which digital I/O line is used for each SPI line. Value passed is 0-22 corresponding to the normal digital I/O numbers as specified in Section 2.9.
• NumSPIBytesToTransfer: Specifies how many SPI bytes will be transferred (1-240).

The initial state of SCK is set properly (CPOL), by this function, before CS (chip select) is brought low (final state is also set properly before CS is brought high again). If CS is being handled manually, outside of this function, care must be taken to make sure SCK is initially set to CPOL before asserting CS.

All standard SPI modes supported (A, B, C, and D).

Mode A: CPOL=0, CPHA=0
Mode B: CPOL=0, CPHA=1
Mode C: CPOL=1, CPHA=0
Mode D: CPOL=1, CPHA=1

If Clock Phase (CPHA) is 1, data is valid on the edge going to CPOL. If CPHA is 0, data is valid on the edge going away from CPOL. Clock Polarity (CPOL) determines the idle state of SCK.

Up to 240 bytes can be written/read. Communication is full duplex so 1 byte is read at the same time each byte is written.

Control command configures the UE9 UART for asynchronous communication.

The UE9 has a UART available that supports asynchronous serial communication. The UART connects to the PIN2/PIN20 (TX0/RX0) pins on the DB37 connector.

Communication is in the common 8/n/1 format. Similar to RS232, except that the logic is normal CMOS/TTL. Connection to an RS232 device will require a converter chip such as the MAX233, which inverts the logic and shifts the voltage levels.

This serial link is not an alternative to the USB connection. Rather, the host application will write/read data to/from the UE9 over USB, and the UE9 communicates with some other device using the serial protocol. Using this serial protocol is considered an advanced topic. A good knowledge of the protocol is recommended, and a logic analyzer or oscilloscope might be needed for troubleshooting.

Table 5.3.17-1. AsynchConfig Command Response

• AsynchOptions: If Update is true, the new parameters are written (otherwise just a read is done). If UARTEnable is true, the UART is enabled and the RX line will start buffering any incoming bytes.
• BaudFactor16: A 16-bit value that sets the baud rate according the following formula: BaudFactor = 2¹⁶-3000000/(Desired Baud). For example, use a BaudFactor of 65224 to get a baud rate of 9615 bps (compatible with 9600 bps).

Control command sends bytes to the UE9 UART which will be sent asynchronously on the PIN2 (TX0) pin on the DB37 connector.

Table 5.3.18-1. AsynchTX Command Response

• NumAsynchWords: This is the number of asynch data bytes divided by 2. If the number of bytes is odd, round up and add an extra zero to the packet.
• NumAsynchBytesToSend: Specifies how many bytes will be sent (0-246).
• NumAsynchBytesInRXBuffer: Returns how many bytes are currently in the RX buffer.

Control command reads the oldest 32 bytes from the UE9 UART RX buffer. The buffer holds 256 bytes.

Table 5.3.19-1. AsynchRX Command Response

• Flush: If nonzero, the entire 256-byte RX buffer is emptied. If there are more than 32 bytes in the buffer that data is lost.
• NumAsynchBytesInRXBuffer: Returns the number of bytes in the buffer before this read.
• AsynchByte#: Returns the 32 oldest bytes from the RX buffer.

Control command sends and receives serial data using I²C synchronous communication.

Table 5.3.20-1. I2C Command Response

• NumI2CWordsSend: This is the number of I2C bytes to send divided by 2. If the number of bytes is odd, round up and add an extra zero to the packet. This parameter is actually just to specify the size of this packet, as the NumI2CbytesToSend parameter below actually specifies how many bytes will be sent.
• I2COptions: If ResetAtStart is true, an I2C bus reset will be done before communicating.
• SpeedAdjust: Allows the communication frequency to be reduced. 0 is the maximum speed of about 150 kHz. 20 is a speed of about 70 kHz. 255 is the minimum speed of about 10 kHz.
• SDAP/SCLP -PinNum: Assigns which digital I/O line is used for each I2C line. Value passed is 0-22 corresponding to the normal digital I/O numbers as specified in Section 2.9. Note that the screw terminals labeled SDA and SCL are not used for I2C. Note that the I2C bus generally requires pull-up resistors of perhaps 4.7 kΩ from SDA to Vs and SCL to Vs.
• Address: This is the first byte of data sent on the I2C bus. The upper 7 bits are the address of the slave chip and bit 0 is the read/write bit. Note that the read/write bit is controlled automatically by the LabJack, and thus bit 0 is ignored.
• NumI2CBytesToSend: Specifies how many I2C bytes will be sent (0-240).
• NumI2CBytesToReceive: Specifies how many I2C bytes will be read (0-240).
• I2Cbyte#: In the command, these are the bytes to send. In the response, these are the bytes read.
• NumI2CWordsReceive: This is the number of I2C bytes to receive divided by 2. If the number of bytes is odd, the value is rounded up and an extra zero is added to the packet. This parameter is actually just to specify the size of this packet, as the NumI2CbytesToReceive parameter above actually specifies how many bytes to read.
• AckArray#: Represents a 32-bit value where bits are set if the corresponding I2C write byte was ACKed. Useful for debugging up to the first 32 write bytes of communication. Bit 0 corresponds to the last data byte, bit 1 corresponds to the second to last data byte, and so on up to the address byte. So if n is the number of data bytes, the ACK value should be (2⁽ⁿ⁺¹⁾)-1.

Control command reads temperature and humidity from a Sensirion SHT1X sensor (which is used by the EI-1050). For more information, see the EI-1050 datasheet, and the SHT1X datasheet from sensirion.com.

Table 5.3.21-1. SHT1X Command Response

• Data/Clock -PinNum: Assigns which digital I/O line is used for each SPI line. Value passed is 0-7 corresponding to FIO0-FIO7.
• StatusReg: Returns a read of the SHT1X status register.
• Temperature: Returns the raw binary temperature reading.
• Humidity: Returns the raw binary humidity reading.
• #CRC: Returns the CRC values from the sensor.
• Options: 
  • Bit 7: Read Humidity
  • Bit 6: Read Temperature
  • Bit 5-3: Reserved, write 0
  • Bit 2: Enable Heater
  • Bit 1: Reserved, write 0
  • Bit 0: Resolution. 1 = 8-bit RH and 12-bit Temp, 0 = 12-bit RH and 14-bit Temp

This function loads a list of binary values that the DACs will output to generate waveforms. Each time stream starts a scan the DAC are set to the next value in their lists. StreamDAC is run by the stream subsystem, so Stream Config needs to be called to set frequency, Stream Start will begin waveform generation and Stream Stop will halt generation.

Table 5.3.22-1. StreamDAC Command Response

To enable StreamDAC set the number of points to a value greater than zero, to disable set the value to zero.

When loading multiple blocks of points, byte 6 (Number of Points) should be set to the total number of points the DAC should cycle through.

Up to 128 points can be loaded, 16 at a time. Use bits [0:2] in byte 9 to select which block of 16 is being loaded.

Executing this function causes the current or last used values (or the factory defaults) to be stored in flash as the power-up defaults.

The UE9 flash has a rated endurance of at least 20000 writes, which is plenty for reasonable operation, but if this function is called in a high-speed loop the flash could eventually be damaged.

Note: Do not call this function while streaming.

Table 5.3.23-1. SetDefaults Command Response

Reads the power-up defaults from flash (Read the current configuration).

Table 5.3.24-1.

This function performs 1-Wire communication.

For additional information on how to use this function, please see the 1-Wire App Note.

Table 5.3.25-1. 1-Wire Command Response

Options: This byte provides control of the dynamic pull-up.
Bit 0: enables control of the DPU line.
Bit 1: sets the polarity of the switch. 1 = high on the specified DIO turns the switch on.
Bit 2: sets the idle state. 1 = DPU on while IDLE.
Sense Pin: This is the DIO on the LabJack that is connected to the data line of the 1-Wire bus.
DPU Pin: This is the DIO line that will control the dynamic pull-up if enabled in the options byte.
ROM Function: This byte specifies the function to be performed on the 1-Wire bus.
ROM[0:7]: This is the ROM of the target device or search path.
Num TX: This is the number of data bytes to transmit.
Num RX: This is the number of data bytes to receive.

Depending on the ROM function used the data returned can have different meanings. Refer to the following table for data definitions.

Table 5.3.25-2. ROM Functions

Additional information

UE9 control firmware v2.20 or later are required for 1-Wire.

Maxim has a 1-Wire App Note on Dynamic Pull-Ups, and another on the search algorithm. There are several kinds of 1-wire temperature sensors from Maxim(DS1820, DS1821, DS1822, DS18S20, and DS18B20). The most common part is probably the DS18B20. Note that these temperature sensors require about 750ms of time to resolve a temperature reading.