FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kSerialOut Class Reference

Description

Represents serial configuration.

Inheritance diagram for kSerialOut:
Inheritance graph

Public Member Functions

k32u kSerialOut_BitRate (kSerialOut serial)
 Gets the bit rate for a serial. More...
 
kStatus kSerialOut_BitRateInfo (kSerialOut serial, kInfo32u *info)
 Reports constraint and validity information for the bit rate setting. More...
 
kStatus kSerialOut_Clear (kSerialOut serial)
 Resets serial output mode settings to defaults. More...
 
kSerialOutControl kSerialOut_Control (kSerialOut serial)
 Reports the control mode of the serial. More...
 
k32u kSerialOut_ControlId (kSerialOut serial)
 Gets the control source id for a serial. More...
 
kStatus kSerialOut_ControlIdInfo (kSerialOut serial, kInfo *info)
 Reports constraint and validity information for the ControlId setting. More...
 
kStatus kSerialOut_ControlInfo (kSerialOut serial, kInfoBits *info)
 Reports constraint and validity information for the Control setting. More...
 
kStatus kSerialOut_Enable (kSerialOut serial, kBool enable)
 Enables or disables the serial. More...
 
kSize kSerialOut_Id (kSerialOut serial)
 Gets the id of the output. More...
 
kBool kSerialOut_IsEnabled (kSerialOut serial)
 Reports whether the serial is currently enabled. More...
 
kSerialOutMode kSerialOut_Mode (kSerialOut serial)
 Gets the mode for a serial. More...
 
kStatus kSerialOut_ModeInfo (kSerialOut serial, kInfoBits *info)
 Reports constraint and validity information for the mode setting. More...
 
kStatus kSerialOut_SetBitRate (kSerialOut serial, k32u rate)
 Sets the bit rate for a serial. More...
 
kStatus kSerialOut_SetControl (kSerialOut serial, kSerialOutControl type)
 Sets the control mode of the serial. More...
 
kStatus kSerialOut_SetControlId (kSerialOut serial, k32u id)
 Sets the control source id for a serial. More...
 
kStatus kSerialOut_SetMode (kSerialOut serial, kSerialOutMode mode)
 Sets the mode for a serial. More...
 
kStatus kSerialOut_Stats (kSerialOut serial, kSerialOutStats *stats)
 Retrieve statistics. More...
 
kStatus kSerialOut_Write (kSerialOut serial, const void *buffer, kSize size)
 Transmit data buffer. More...
 

The documentation for this class was generated from the following file: