sbgECom
1.11.920-stable
|
This file implements SbgECom commands related to outputs. More...
Go to the source code of this file.
Data Structures | |
struct | _SbgEComLegacyConf |
Typedefs | |
typedef enum _SbgEComOutputPort | SbgEComOutputPort |
typedef enum _SbgEComLegacyFormat | SbgEComLegacyFormat |
typedef enum _SbgEComLegacyEndian | SbgEComLegacyEndian |
typedef enum _SbgEComOutputMode | SbgEComOutputMode |
typedef enum _SbgEComOutputMonitoringPoint | SbgEComOutputMonitoringPoint |
typedef struct _SbgEComLegacyConf | SbgEComLegacyConf |
This file implements SbgECom commands related to outputs.
Copyright (C) 2007-2013, SBG Systems SAS. All rights reserved.
This source code is intended for use only by SBG Systems SAS and those that have explicit written permission to use it from SBG Systems SAS.
THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
typedef enum _SbgEComOutputPort SbgEComOutputPort |
List of ouput ports available.
typedef enum _SbgEComLegacyFormat SbgEComLegacyFormat |
List of available legacy output format.
typedef enum _SbgEComLegacyEndian SbgEComLegacyEndian |
List of available legacy output endiannesses.
typedef enum _SbgEComOutputMode SbgEComOutputMode |
List of output modes available.
Defines which monitoring point to use for an output port. This feature enabled deporting measurements at a specific monitoring point.
typedef struct _SbgEComLegacyConf SbgEComLegacyConf |
Helper structure to configure legacy output.
enum _SbgEComOutputPort |
enum _SbgEComLegacyFormat |
enum _SbgEComLegacyEndian |
enum _SbgEComOutputMode |
List of output modes available.
Defines which monitoring point to use for an output port. This feature enabled deporting measurements at a specific monitoring point.
SbgErrorCode sbgEComCmdOutputGetConf | ( | SbgEComHandle * | pHandle, |
SbgEComOutputPort | outputPort, | ||
SbgEComClass | classId, | ||
SbgEComMsgId | msgId, | ||
SbgEComOutputMode * | pMode | ||
) |
Retrieve the configuration of one the message on one of the output interfaces.
[in] | pHandle | A valid sbgECom handle. |
[in] | outputPort | The output port of the device for the log concerned. |
[in] | classId | The class of the concerned log. |
[in] | msgId | The id of the concerned log. |
[out] | pMode | Pointer to a SbgEComOutputMode to contain the current output mode of the message. |
SbgErrorCode sbgEComCmdOutputSetConf | ( | SbgEComHandle * | pHandle, |
SbgEComOutputPort | outputPort, | ||
SbgEComClass | classId, | ||
SbgEComMsgId | msgId, | ||
SbgEComOutputMode | mode | ||
) |
Set the configuration of one the message on one of the output interfaces.
[in] | pHandle | A valid sbgECom handle. |
[in] | outputPort | The output port of the device for the log concerned. |
[in] | classId | The class of the concerned log. |
[in] | msgId | The id of the concerned log. |
[in] | mode | New output mode to set. |
SbgErrorCode sbgEComCmdOutputClassGetEnable | ( | SbgEComHandle * | pHandle, |
SbgEComOutputPort | outputPort, | ||
SbgEComClass | classId, | ||
bool * | pEnable | ||
) |
Retrieve the enable of one of the output class message on one of the output interfaces.
[in] | pHandle | A valid sbgECom handle. |
[in] | outputPort | The output port. |
[in] | classId | The class to enable or disable. |
[out] | pEnable | TRUE to enable message output of this class, FALSE to disable it. |
SbgErrorCode sbgEComCmdOutputClassSetEnable | ( | SbgEComHandle * | pHandle, |
SbgEComOutputPort | outputPort, | ||
SbgEComClass | classId, | ||
bool | enable | ||
) |
Set the enable of one of the output class message on one of the output interfaces.
[in] | pHandle | A valid sbgECom handle. |
[in] | outputPort | The output port. |
[in] | classId | The class to enable or disable. |
[in] | enable | TRUE to enable message output of this class, FALSE to disable it. |
SbgErrorCode sbgEComCmdCanOutputGetConf | ( | SbgEComHandle * | pHandle, |
SbgECanMessageId | internalId, | ||
SbgEComOutputMode * | pMode, | ||
uint32_t * | pUserId, | ||
bool * | pExtended | ||
) |
Retrieve the configuration of one the message on the CAN interface.
[in] | pHandle | A valid sbgECom handle. |
[in] | internalId | The internal message id. |
[out] | pMode | Pointer to a SbgEComOutputMode to contain the current output mode of the message. |
[out] | pUserId | The user defined message id. |
[out] | pExtended | TRUE if the user id uses the extended format. |
SbgErrorCode sbgEComCmdCanOutputSetConf | ( | SbgEComHandle * | pHandle, |
SbgECanMessageId | internalId, | ||
SbgEComOutputMode | mode, | ||
uint32_t | userId, | ||
bool | extended | ||
) |
Set the configuration of one the message on the CAN interface
[in] | pHandle | A valid sbgECom handle. |
[in] | internalId | The internal message id. |
[in] | mode | Pointer to a SbgEComOutputMode containing the new output mode of the message. |
[in] | userId | The user defined message id. |
[in] | extended | TRUE if the user id uses the extended format. |
SbgErrorCode sbgEComCmdOutputGetLegacyConf | ( | SbgEComHandle * | pHandle, |
SbgEComOutputPort | outputPort, | ||
SbgEComLegacyConf * | pConf | ||
) |
Retrieve the configuration of one the message on one of the output interfaces.
[in] | pHandle | A valid sbgECom handle. |
[in] | outputPort | The output port of the device for the log concerned. |
[out] | pConf | Pointer to a SbgEComLegacyConf structure to contain legacy configuration. |
SbgErrorCode sbgEComCmdOutputSetLegacyConf | ( | SbgEComHandle * | pHandle, |
SbgEComOutputPort | outputPort, | ||
const SbgEComLegacyConf * | pConf | ||
) |
Set the configuration of one the message on one of the output interfaces.
[in] | pHandle | A valid sbgECom handle. |
[in] | outputPort | The output port of the device for the log concerned. |
[in] | pConf | Pointer to a SbgEComLegacyConf structure containing new legacy configuration. |
SbgErrorCode sbgEComCmdOutputGetNmeaTalkerId | ( | SbgEComHandle * | pHandle, |
SbgEComOutputPort | outputPort, | ||
char | nmeaTalkerId[2] | ||
) |
Retrieve the NMEA talker id of one of the output interfaces.
[in] | pHandle | A valid sbgECom handle. |
[in] | outputPort | The output port of the device for the log concerned. |
[out] | nmeaTalkerId | A 2-char array to contain the nmea talker id. |
SbgErrorCode sbgEComCmdOutputSetNmeaTalkerId | ( | SbgEComHandle * | pHandle, |
SbgEComOutputPort | outputPort, | ||
const char | nmeaTalkerId[2] | ||
) |
Set the NMEA talker id of one of the output interfaces.
[in] | pHandle | A valid sbgECom handle. |
[in] | outputPort | The output port of the device for the log concerned. |
[out] | nmeaTalkerId | A 2-char array containint the new nmea talker id. |