sbgECom Library  4.0.1987-stable
C library to interface SBG Systems IMU/AHRS/INS
Functions
sbgInterfaceSerial.h File Reference
Common

This file implements a serial interface. More...

#include <sbgCommon.h>
#include <interfaces/sbgInterface.h>

Go to the source code of this file.

Functions

SBG_COMMON_LIB_API SbgErrorCode sbgInterfaceSerialCreate (SbgInterface *pInterface, const char *deviceName, uint32_t baudRate)
 

Detailed Description

This file implements a serial interface.

Author
SBG Systems
Date
06 February 2013
Copyright
Copyright (C) 2022, SBG Systems SAS. All rights reserved.
License

The MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Function Documentation

◆ sbgInterfaceSerialCreate()

SBG_COMMON_LIB_API SbgErrorCode sbgInterfaceSerialCreate ( SbgInterface *  pInterface,
const char *  deviceName,
uint32_t  baudRate 
)

Initialize a serial interface for read and write operations.

Parameters
[in]pInterfacePointer on an allocated interface instance to initialize.
[in]deviceNameSerial interface location (COM21 , /dev/ttys0, depending on platform).
[in]baudRateSerial interface baud rate in bps.
Returns
SBG_NO_ERROR if the interface has been created.