AFBR-S50 API Reference Manual v1.5.6
AFBR-S50 Time-of-Flight Sensor SDK for Embedded Software
Loading...
Searching...
No Matches

SCI Handshaking Module. More...

Collaboration diagram for SCI: Handshaking:

Functions

status_t SCI_SendAcknowledge (sci_device_t deviceID, sci_cmd_t cmd)
 Sends an Acknowledge message.
 
status_t SCI_SendNotAcknowledge (sci_device_t deviceID, sci_cmd_t cmd, status_t reason)
 Sends an Not-Acknowledge message.
 

Detailed Description

SCI Handshaking Module.


Implements the handshaking command messages:

Function Documentation

◆ SCI_SendAcknowledge()

status_t SCI_SendAcknowledge ( sci_device_t  deviceID,
sci_cmd_t  cmd 
)

Sends an Acknowledge message.


Parameters
deviceIDThe ID (index) of the SPI device that should process the received frame. This is only used for extended commands!
cmdThe command that is acknowledged. If extended command is passed, the frame will contain the deviceID.
Returns
Returns the status (STATUS_OK on success).

◆ SCI_SendNotAcknowledge()

status_t SCI_SendNotAcknowledge ( sci_device_t  deviceID,
sci_cmd_t  cmd,
status_t  reason 
)

Sends an Not-Acknowledge message.


Parameters
deviceIDThe ID (index) of the SPI device that should process the received frame. This is only used for extended commands!
cmdThe command that is not-acknowledged. If extended command is passed, the frame will contain the deviceID.
reasonThe reason/status that caused the not-acknowledged.
Returns
Returns the status (STATUS_OK on success).