sbgECom  1.11.920-stable
Data Structures | Typedefs | Enumerations | Functions
sbgEComCmdOutput.h File Reference

This file implements SbgECom commands related to outputs. More...

#include "sbgEComCmdCommon.h"
#include "../sbgECanId.h"

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
 

Enumerations

enum  _SbgEComOutputPort {
  SBG_ECOM_OUTPUT_PORT_A = 0,
  SBG_ECOM_OUTPUT_PORT_C = 2,
  SBG_ECOM_OUTPUT_PORT_E = 4
}
 
enum  _SbgEComLegacyFormat {
  SBG_ECOM_LEGACY_FORMAT_FLOAT = 0,
  SBG_ECOM_LEGACY_FORMAT_FIXED
}
 
enum  _SbgEComLegacyEndian {
  SBG_ECOM_LEGACY_LITTLE_ENDIAN = 0,
  SBG_ECOM_LEGACY_BIG_ENDIAN
}
 
enum  _SbgEComOutputMode {
  SBG_ECOM_OUTPUT_MODE_DISABLED = 0,
  SBG_ECOM_OUTPUT_MODE_MAIN_LOOP = 1,
  SBG_ECOM_OUTPUT_MODE_DIV_2 = 2,
  SBG_ECOM_OUTPUT_MODE_DIV_4 = 4,
  SBG_ECOM_OUTPUT_MODE_DIV_5 = 5,
  SBG_ECOM_OUTPUT_MODE_DIV_8 = 8,
  SBG_ECOM_OUTPUT_MODE_DIV_10 = 10,
  SBG_ECOM_OUTPUT_MODE_DIV_20 = 20,
  SBG_ECOM_OUTPUT_MODE_DIV_40 = 40,
  SBG_ECOM_OUTPUT_MODE_DIV_200 = 200,
  SBG_ECOM_OUTPUT_MODE_PPS = 10000,
  SBG_ECOM_OUTPUT_MODE_NEW_DATA = 10001,
  SBG_ECOM_OUTPUT_MODE_EVENT_IN_A = 10003,
  SBG_ECOM_OUTPUT_MODE_EVENT_IN_B = 10004,
  SBG_ECOM_OUTPUT_MODE_EVENT_IN_C = 10005,
  SBG_ECOM_OUTPUT_MODE_EVENT_IN_D = 10006,
  SBG_ECOM_OUTPUT_MODE_EVENT_IN_E = 10007,
  SBG_ECOM_OUTPUT_MODE_HIGH_FREQ_LOOP = 20001
}
 
enum  _SbgEComOutputMonitoringPoint {
  SBG_ECOM_OUTPUT_MONITORING_POINT_IMU = 0,
  SBG_ECOM_OUTPUT_MONITORING_POINT_COG = 1,
  SBG_ECOM_OUTPUT_MONITORING_POINT_1 = 2,
  SBG_ECOM_OUTPUT_MONITORING_POINT_2 = 3,
  SBG_ECOM_OUTPUT_MONITORING_POINT_3 = 4,
  SBG_ECOM_OUTPUT_MONITORING_NUM
}
 

Functions

SbgErrorCode sbgEComCmdOutputGetConf (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, SbgEComClass classId, SbgEComMsgId msgId, SbgEComOutputMode *pMode)
 
SbgErrorCode sbgEComCmdOutputSetConf (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, SbgEComClass classId, SbgEComMsgId msgId, SbgEComOutputMode mode)
 
SbgErrorCode sbgEComCmdOutputClassGetEnable (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, SbgEComClass classId, bool *pEnable)
 
SbgErrorCode sbgEComCmdOutputClassSetEnable (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, SbgEComClass classId, bool enable)
 
SbgErrorCode sbgEComCmdCanOutputGetConf (SbgEComHandle *pHandle, SbgECanMessageId internalId, SbgEComOutputMode *pMode, uint32_t *pUserId, bool *pExtended)
 
SbgErrorCode sbgEComCmdCanOutputSetConf (SbgEComHandle *pHandle, SbgECanMessageId internalId, SbgEComOutputMode mode, uint32_t userId, bool extended)
 
SbgErrorCode sbgEComCmdOutputGetLegacyConf (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, SbgEComLegacyConf *pConf)
 
SbgErrorCode sbgEComCmdOutputSetLegacyConf (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, const SbgEComLegacyConf *pConf)
 
SbgErrorCode sbgEComCmdOutputGetNmeaTalkerId (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, char nmeaTalkerId[2])
 
SbgErrorCode sbgEComCmdOutputSetNmeaTalkerId (SbgEComHandle *pHandle, SbgEComOutputPort outputPort, const char nmeaTalkerId[2])
 

Detailed Description

This file implements SbgECom commands related to outputs.

Author
SBG Systems (Maxime Renaudet)
Date
11 June 2014

Copyright Notice

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 Documentation

§ SbgEComOutputPort

List of ouput ports available.

§ SbgEComLegacyFormat

List of available legacy output format.

§ SbgEComLegacyEndian

List of available legacy output endiannesses.

§ SbgEComOutputMode

List of output modes available.

§ SbgEComOutputMonitoringPoint

Defines which monitoring point to use for an output port. This feature enabled deporting measurements at a specific monitoring point.

§ SbgEComLegacyConf

Helper structure to configure legacy output.

Enumeration Type Documentation

§ _SbgEComOutputPort

List of ouput ports available.

Enumerator
SBG_ECOM_OUTPUT_PORT_A 

Main output port.

SBG_ECOM_OUTPUT_PORT_C 

Secondary output port only available on Ellipse-E devices

SBG_ECOM_OUTPUT_PORT_E 

Secondary output port only available on B1 devices

§ _SbgEComLegacyFormat

List of available legacy output format.

Enumerator
SBG_ECOM_LEGACY_FORMAT_FLOAT 

Data is output in floating point.

SBG_ECOM_LEGACY_FORMAT_FIXED 

Data is output in fixed point.

§ _SbgEComLegacyEndian

List of available legacy output endiannesses.

Enumerator
SBG_ECOM_LEGACY_LITTLE_ENDIAN 

Data is output in little endian format.

SBG_ECOM_LEGACY_BIG_ENDIAN 

Data is output in big endian format.

§ _SbgEComOutputMode

List of output modes available.

Enumerator
SBG_ECOM_OUTPUT_MODE_DISABLED 

This output is disabled.

SBG_ECOM_OUTPUT_MODE_MAIN_LOOP 

Output the message every main loop (ie 200 Hz).

SBG_ECOM_OUTPUT_MODE_DIV_2 

Output the message every 2 main loops (ie 100 Hz).

SBG_ECOM_OUTPUT_MODE_DIV_4 

Output the message every 4 main loops (ie 50 Hz).

SBG_ECOM_OUTPUT_MODE_DIV_5 

Output the message every 4 main loops (ie 40 Hz).

SBG_ECOM_OUTPUT_MODE_DIV_8 

Output the message every 8 main loops (ie 25 Hz).

SBG_ECOM_OUTPUT_MODE_DIV_10 

Output the message every 10 main loops (ie 20 Hz).

SBG_ECOM_OUTPUT_MODE_DIV_20 

Output the message every 20 main loops (ie 10 Hz).

SBG_ECOM_OUTPUT_MODE_DIV_40 

Output the message every 40 main loops (ie 5 Hz).

SBG_ECOM_OUTPUT_MODE_DIV_200 

Output the message every 200 main loops (ie 1 Hz).

SBG_ECOM_OUTPUT_MODE_PPS 

Output the message on a Pulse Per Second event.

SBG_ECOM_OUTPUT_MODE_NEW_DATA 

Output sent when a new data is available.

SBG_ECOM_OUTPUT_MODE_EVENT_IN_A 

Output the message when a Sync A is received.

SBG_ECOM_OUTPUT_MODE_EVENT_IN_B 

Output the message when a Sync B is received.

SBG_ECOM_OUTPUT_MODE_EVENT_IN_C 

Output the message when a Sync C is received.

SBG_ECOM_OUTPUT_MODE_EVENT_IN_D 

Output the message when a Sync D is received.

SBG_ECOM_OUTPUT_MODE_EVENT_IN_E 

Output the message when a Sync E is received.

SBG_ECOM_OUTPUT_MODE_HIGH_FREQ_LOOP 

Output the message in the 1KHz IMU loop

§ _SbgEComOutputMonitoringPoint

Defines which monitoring point to use for an output port. This feature enabled deporting measurements at a specific monitoring point.

Enumerator
SBG_ECOM_OUTPUT_MONITORING_POINT_IMU 

Output measurements at the IMU location.

SBG_ECOM_OUTPUT_MONITORING_POINT_COG 

Output measurements at the center of rotation.

SBG_ECOM_OUTPUT_MONITORING_POINT_1 

Output measurements at the user deported location 1 (only for Ekinox and Apogee).

SBG_ECOM_OUTPUT_MONITORING_POINT_2 

Output measurements at the user deported location 2 (only for Ekinox and Apogee).

SBG_ECOM_OUTPUT_MONITORING_POINT_3 

Output measurements at the user deported location 3 (only for Ekinox and Apogee).

SBG_ECOM_OUTPUT_MONITORING_NUM 

Number of output monitoring points.

Function Documentation

§ sbgEComCmdOutputGetConf()

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.

Parameters
[in]pHandleA valid sbgECom handle.
[in]outputPortThe output port of the device for the log concerned.
[in]classIdThe class of the concerned log.
[in]msgIdThe id of the concerned log.
[out]pModePointer to a SbgEComOutputMode to contain the current output mode of the message.
Returns
SBG_NO_ERROR if the command has been executed successfully.

§ sbgEComCmdOutputSetConf()

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.

Parameters
[in]pHandleA valid sbgECom handle.
[in]outputPortThe output port of the device for the log concerned.
[in]classIdThe class of the concerned log.
[in]msgIdThe id of the concerned log.
[in]modeNew output mode to set.
Returns
SBG_NO_ERROR if the command has been executed successfully.

§ sbgEComCmdOutputClassGetEnable()

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.

Parameters
[in]pHandleA valid sbgECom handle.
[in]outputPortThe output port.
[in]classIdThe class to enable or disable.
[out]pEnableTRUE to enable message output of this class, FALSE to disable it.
Returns
SBG_NO_ERROR if the command has been executed successfully.

§ sbgEComCmdOutputClassSetEnable()

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.

Parameters
[in]pHandleA valid sbgECom handle.
[in]outputPortThe output port.
[in]classIdThe class to enable or disable.
[in]enableTRUE to enable message output of this class, FALSE to disable it.
Returns
SBG_NO_ERROR if the command has been executed successfully.

§ sbgEComCmdCanOutputGetConf()

SbgErrorCode sbgEComCmdCanOutputGetConf ( SbgEComHandle pHandle,
SbgECanMessageId  internalId,
SbgEComOutputMode pMode,
uint32_t *  pUserId,
bool *  pExtended 
)

Retrieve the configuration of one the message on the CAN interface.

Parameters
[in]pHandleA valid sbgECom handle.
[in]internalIdThe internal message id.
[out]pModePointer to a SbgEComOutputMode to contain the current output mode of the message.
[out]pUserIdThe user defined message id.
[out]pExtendedTRUE if the user id uses the extended format.
Returns
SBG_NO_ERROR if the command has been executed successfully.

§ sbgEComCmdCanOutputSetConf()

SbgErrorCode sbgEComCmdCanOutputSetConf ( SbgEComHandle pHandle,
SbgECanMessageId  internalId,
SbgEComOutputMode  mode,
uint32_t  userId,
bool  extended 
)

Set the configuration of one the message on the CAN interface

Parameters
[in]pHandleA valid sbgECom handle.
[in]internalIdThe internal message id.
[in]modePointer to a SbgEComOutputMode containing the new output mode of the message.
[in]userIdThe user defined message id.
[in]extendedTRUE if the user id uses the extended format.
Returns
SBG_NO_ERROR if the command has been executed successfully.

§ sbgEComCmdOutputGetLegacyConf()

SbgErrorCode sbgEComCmdOutputGetLegacyConf ( SbgEComHandle pHandle,
SbgEComOutputPort  outputPort,
SbgEComLegacyConf pConf 
)

Retrieve the configuration of one the message on one of the output interfaces.

Parameters
[in]pHandleA valid sbgECom handle.
[in]outputPortThe output port of the device for the log concerned.
[out]pConfPointer to a SbgEComLegacyConf structure to contain legacy configuration.
Returns
SBG_NO_ERROR if the command has been executed successfully.

§ sbgEComCmdOutputSetLegacyConf()

SbgErrorCode sbgEComCmdOutputSetLegacyConf ( SbgEComHandle pHandle,
SbgEComOutputPort  outputPort,
const SbgEComLegacyConf pConf 
)

Set the configuration of one the message on one of the output interfaces.

Parameters
[in]pHandleA valid sbgECom handle.
[in]outputPortThe output port of the device for the log concerned.
[in]pConfPointer to a SbgEComLegacyConf structure containing new legacy configuration.
Returns
SBG_NO_ERROR if the command has been executed successfully.

§ sbgEComCmdOutputGetNmeaTalkerId()

SbgErrorCode sbgEComCmdOutputGetNmeaTalkerId ( SbgEComHandle pHandle,
SbgEComOutputPort  outputPort,
char  nmeaTalkerId[2] 
)

Retrieve the NMEA talker id of one of the output interfaces.

Parameters
[in]pHandleA valid sbgECom handle.
[in]outputPortThe output port of the device for the log concerned.
[out]nmeaTalkerIdA 2-char array to contain the nmea talker id.
Returns
SBG_NO_ERROR if the command has been executed successfully.

§ sbgEComCmdOutputSetNmeaTalkerId()

SbgErrorCode sbgEComCmdOutputSetNmeaTalkerId ( SbgEComHandle pHandle,
SbgEComOutputPort  outputPort,
const char  nmeaTalkerId[2] 
)

Set the NMEA talker id of one of the output interfaces.

Parameters
[in]pHandleA valid sbgECom handle.
[in]outputPortThe output port of the device for the log concerned.
[out]nmeaTalkerIdA 2-char array containint the new nmea talker id.
Returns
SBG_NO_ERROR if the command has been executed successfully.