Skip to main content

I2C Nodes

the i2c library allows users to create i2c master.

Config Nodes​

i2c config​

Handles settings for communication using I2C.

Inputs

  • I2C Port : Select the I2C port number
  • SDA Pin : Specify the SDA pin for communication
  • SCL Pin : Specify the SCL pin for communication
  • I2C Freq(Hz) : Specify the clock speed(frequency) for I2C communication
  • SDA Pullup Enable : Activate the pull-up resistor on the SDA (data) line
  • SCL Pullup Enable : Activate the pull-up resistor on the SCL (clock) line

i2c commands config​

Handles settings for communication commands using I2C.

Inputs

  • Command name : Set the Command Name

Proc Nodes​

i2c driver install​

Install an I2C driver.

Inputs

  • I2C port : Select the I2C port to install the driver on
  • I2C Mode : Select the operating mode for I2C interface
  • Rx buf len : Specify the length of the receive buffer for I2C data
  • Tx buf len : Specify the length of the transmit buffer for I2C data
  • Inter flags : Bitmap to set interrupt flags for I2C to handle specific events or errors during communication
  • Start : Begin I2C communication by generating a start condition

i2c transfer​

transrecieve the data from the I2C communication.

Inputs

  • I2C port : i2c port refers to the specific I2C bus or interface used for communication
  • Address : Specifies the 7-bit or 10-bit address of the I2C slave device involved in the communication
  • Read / Write : read data from i2c slave device , write data to the i2c slave device
  • Data : The actual information transmitted between i2c master and slave devices during communication
  • Recieve length : Defines the number of bytes the master expects to receive from the slave during an I2C read operation.
  • Start Enable : Initiates an I2C start condition to begin communication with a slave device
  • Stop Enable : Sends a stop condition to terminate the I2C communication.
  • Acknowledge Enable : Enables the sending of an acknowledgment after receiving a byte in I2C communication.

Outputs

  • data : Received Data

i2c driver install​

Install an I2C driver.

Inputs

  • I2C port : Select I2C port
  • I2C Mode : Select I2C mode
  • Rx buf len : Specify RX buffer lenght
  • Tx buf len : Specify TX buffer length
  • Inter flags : Specify bitmap for Interrupt flags
  • Start : Select start

i2c driver delete​

Delete an I2C driver.

Inputs

  • I2C port : Specifies the I2C bus/interface used for communication.

reset tx fifo​

Reset an I2C tx fifo.

Inputs

  • I2C port : Clears the I2C transmit FIFO buffer to remove any pending data.

reset rx fifo​

Reset an I2C rx fifo.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.

i2c set pin​

Configure GPIO pins for I2C SCL and SDA signals.

Inputs

  • Config : Assigns SDA and SCL pins for I2C communication.
  • I2C port : Identifies the specific I2C interface used for communication.
  • SDA Pin : set SDA pin
  • SCL Pin : set SCL pin
  • SDA Pullup Enable : Activates the pull-up resistor on the SDA (data) line to ensure proper I2C signal levels.
  • SCL Pullup Enable : Activates the pull-up resistor on the SCL (clock) line to ensure proper I2C signal levels.
  • I2C Mode : Sets the I2C interface to master or slave mode.

i2c get pin​

Get I2C pins.

Inputs

  • Config : Sets up or configures the I2C interface with parameters like speed, addressing mode, and pin assignments.

Outputs

  • SDA Pin : SDA Pin
  • SCL Pin : SCL Pin

i2c master write​

Perform a write to a device connected to a particular I2C port.

Inputs

  • I2C port : Specifies the I2C bus/interface used for communication
  • Device address : The unique 7-bit or 10-bit address assigned to an I2C slave device for identification during communication.
  • Write Data : Sends data from the I2C master to the slave device on the I2C bus.
  • Size : Specifies the number of bytes of data to be transmitted or received in I2C communication.
  • Ticks to wait : Specifies the number of clock cycles to wait before continuing the I2C operation.

i2c master read​

Perform a read to a device connected to a particular I2C port.

Inputs

  • I2C port : Reads data from an I2C slave device to the I2C master.
  • Device address : The unique 7-bit or 10-bit address assigned to an I2C slave device for identification during communication.
  • Read Data : Retrieves data from an I2C slave device to the I2C master.
  • Size : Specifies the number of bytes of data to be transmitted or received in I2C communication.
  • Ticks to wait : Specifies the number of clock cycles to wait before continuing the I2C operation.

Outputs

  • Bytes read : Bytes read

i2c master write read​

Perform a write followed by a read device on the I2C bus.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.
  • Device address : The unique 7-bit or 10-bit address assigned to an I2C slave device for identification during communication.
  • Write Data : Sends data from the I2C master to the slave device on the I2C bus.
  • Size : Specifies the number of bytes to be written or read during I2C communication between the master and slave.
  • Read Data : Retrieves data from an I2C slave device to the I2C master.
  • Size : Specifies the number of bytes to be written or read during I2C communication between the master and slave.
  • Ticks to wait : ets the number of clock cycles to wait before continuing a write or read operation.

i2c set period​

Set I2C master clock period.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.
  • High period : Sets the duration of the high phase of the I2C clock signal.
  • Low period : Sets the duration of the low phase of the I2C clock sign

i2c get period​

Get I2C master clock period.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.

Outputs

  • High period : High Period
  • Low period : Low Period

change i2c filter status​

Enable/Disable hardware filter on I2C bus.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.
  • Cycle num : Specifies the number of clock cycles for a particular I2C operation or communication period.
  • Select : Chooses a specific option or setting in I2C communication.

i2c set start timing​

Set I2C master start signal timing.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.
  • Setup time : Defines the minimum time for data to remain stable before the clock edge in I2C.
  • Hold time : Specifies the minimum time the data signal must remain stable after the clock edge in I2C communication.

i2c get start timing​

Get I2C master start signal timing.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.

Outputs

  • Start hold time : Start hold time
  • Start setup time : Start setup time

i2c set stop timing​

Set I2C master stop signal timing.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.
  • Setup time : Defines the minimum time for data to remain stable before the clock edge in I2C.
  • Hold time : Specifies the minimum time the data signal must remain stable after the clock edge in I2C communication.

i2c get stop timing​

Get I2C master stop signal timing.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.

i2c set data timing​

Set I2C master data signal timing.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.
  • Sample time : Specifies the time when the data is sampled or read during the clock cycle in I2C communication.
  • Hold time : Specifies the minimum time the data signal must remain stable after the clock edge in I2C communication.

i2c get data timing​

Get I2C master data signal timing.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.

i2c set timeout​

Set I2C timeout value.

Inputs

  • I2C port : Configures the maximum time to wait for an I2C operation to complete before timing out.
  • Time : Defines the duration to wait for an I2C operation before timing out.

i2c get timeout​

Get I2C timeout value.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.

Outputs

  • Time out : Timeout

i2c set data mode​

Set I2C data transfer mode.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.
  • Tx trans mode : Configures the transmission mode for sending data on the I2C bus, such as single or continuous transfer.
  • Rx trans mode : Configures the reception mode for receiving data on the I2C bus, such as single or continuous transfer.

i2c get data mode​

Get I2C data transfer mode.

Inputs

  • I2C port : Identifies the specific I2C interface used for communication.

change i2c master status​

“START/STOP signal” to the given commands list.

Inputs

  • Config : Sets up or configures the I2C interface with parameters like speed, addressing mode, and pin assignments.
  • Start / Stop : Initiates (Start) or terminates (Stop) communication on the I2C bus, signaling the beginning or end of data transfer.

i2c command master write​

Write multiple bytes command to the commands list.

Inputs

  • Config : Sets up or configures the I2C interface with parameters like speed, addressing mode, and pin assignments.
  • Write Data : Sends data from the I2C master to the slave device on the I2C bus.
  • Size : Specifies the number of bytes of data to be transmitted or received in I2C communication.
  • Acknowledge Enable : Enables the sending of an acknowledgment (ACK) after receiving a byte in I2C communication.

i2c command master write byte​

Write byte command to the commands list.

Inputs

  • Config : Sets up or configures the I2C interface with parameters like speed, addressing mode, and pin assignments.
  • Write Data : Sends data from the I2C master to the slave device on the I2C bus.
  • Acknowledge Enable : Enables the sending of an acknowledgment (ACK) after receiving a byte in I2C communication.

i2c command master read​

Read multiple bytes command to the commands list.

Inputs

  • Config : Sets up or configures the I2C interface with parameters like speed, addressing mode, and pin assignments.
  • Read Data : Retrieves data from an I2C slave device to the I2C master.
  • Size : Specifies the number of bytes of data to be transmitted or received in I2C communication.
  • Acknowledge : Sends an acknowledgment signal (ACK) to confirm successful reception of data during I2C communication.

i2c command master read byte​

Read byte command to the commands list.

Inputs

  • Config : Sets up or configures the I2C interface with parameters like speed, addressing mode, and pin assignments.
  • Read Data : Retrieves data from an I2C slave device to the I2C master.
  • Acknowledge : Sends an acknowledgment signal (ACK) to confirm successful reception of data during I2C communication.

Free the I2C commands list.

Inputs

  • Config : Sets up or configures the I2C interface with parameters like speed, addressing mode, and pin assignments.