Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

I2CSlave Class Reference
Public Member Functions

I2CSlave Class Reference
[I2CSlave class]

An I2C Slave, used for communicating with an I2C Master device. More...

#include <I2CSlave.h>

Public Member Functions

 I2CSlave (PinName sda, PinName scl)
 Create an I2C Slave interface, connected to the specified pins.
 I2CSlave (const i2c_pinmap_t &static_pinmap)
 Create an I2C Slave interface, connected to the specified pins.
void frequency (int hz)
 Set the frequency of the I2C interface.
int receive (void)
 Check if this I2C Slave has been addressed.
int read (char *data, int length)
 Read specified number of bytes from an I2C master.
int read (void)
 Read a single byte from an I2C master.
int write (const char *data, int length)
 Write to an I2C master.
int write (int data)
 Write a single byte to an I2C master.
void address (int address)
 Set the I2C slave address.
void stop (void)
 Reset the I2C slave back into the known ready receiving state.

Detailed Description

An I2C Slave, used for communicating with an I2C Master device.

Note:
Synchronization level: Not protected

Example Simple I2C responder: 

 #include <mbed.h>

 const int SLAVE_ADDRESS = 0xA0;
 const char message[] = "Slave!";

 I2CSlave slave(I2C_SDA, I2C_SCL);

 int main() {
     slave.address(SLAVE_ADDRESS);
     while (1) {
         int operation = slave.receive();
         switch (operation) {
             case I2CSlave::ReadAddressed:
                 int status = slave.write(message, sizeof(message));
                 if (status == 0) {
                     printf("Written message: %s\n", message);
                 } else {
                     printf("Failed to write message.\n");
                 }
                 break;
             case I2CSlave::WriteGeneral:
                 int byte_read = slave.read();
                 printf("Read General: %c (%d)\n", byte_read, byte_read);
                 break;
             case I2CSlave::WriteAddressed:
                 int byte_read = slave.read();
                 printf("Read Addressed: %c (%d)\n", byte_read, byte_read);
                 break;
         }
     }
 }

Definition at line 72 of file I2CSlave.h.

Constructor & Destructor Documentation

I2CSlave ( PinName  sda,
PinName  scl 
)

Create an I2C Slave interface, connected to the specified pins.

Parameters:
sdaI2C data line pin.
sclI2C clock line pin.

Definition at line 23 of file I2CSlave.cpp.

I2CSlave ( const i2c_pinmap_t &  static_pinmap )

Create an I2C Slave interface, connected to the specified pins.

Parameters:
static_pinmapreference to structure which holds static pinmap.

Definition at line 30 of file I2CSlave.cpp.

Member Function Documentation

void address ( int  address )

Set the I2C slave address.

Parameters:
addressThe address to set for the slave (least significant bit is ignored).
Note:
If address is set to 0, the slave will only respond to the general call address.

Definition at line 42 of file I2CSlave.cpp.

void frequency ( int  hz )

Set the frequency of the I2C interface.

Parameters:
hzThe bus frequency in Hertz.

Definition at line 37 of file I2CSlave.cpp.

int read ( void   )

Read a single byte from an I2C master.

Returns:
The byte read.

Definition at line 58 of file I2CSlave.cpp.

int read ( char *  data,
int  length 
)

Read specified number of bytes from an I2C master.

Parameters:
dataPointer to the buffer to read data into.
lengthNumber of bytes to read.
Returns:
Result of the operation.
Return values:
0If the number of bytes read is equal to length requested.
nonzeroOn error or if the number of bytes read is less than requested.

Definition at line 53 of file I2CSlave.cpp.

int receive ( void   )

Check if this I2C Slave has been addressed.

Returns:
A status indicating if the device has been addressed and how.
Return values:
NoDataThe slave has not been addressed.
ReadAddressedThe master has requested a read from this slave.
WriteAddressedThe master is writing to this slave.
WriteGeneralThe master is writing to all slave.

Definition at line 48 of file I2CSlave.cpp.

void stop ( void   )

Reset the I2C slave back into the known ready receiving state.

Definition at line 73 of file I2CSlave.cpp.

int write ( int  data )

Write a single byte to an I2C master.

Parameters:
dataValue to write.
Returns:
Result of the operation.
Return values:
0If a NACK is received.
1If an ACK is received.
2On timeout.

Definition at line 68 of file I2CSlave.cpp.

int write ( const char *  data,
int  length 
)

Write to an I2C master.

Parameters:
dataPointer to the buffer containing the data to be sent.
lengthNumber of bytes to send.
Returns:
Return values:
0If written all bytes successfully.
nonzeroOn error or if the number of bytes written is less than requested.

Definition at line 63 of file I2CSlave.cpp.

Generated on Tue Jul 12 2022 13:55:42 by  doxygen 1.7.2