sbgEComCmdEvent.h File Reference

Input/output event markers configuration commands. More...

#include <sbgCommon.h>
#include <sbgECom.h>

Go to the source code of this file.

Data Structures
struct	_SbgEComSyncInConf
struct	_SbgEComSyncOutConf

Typedefs
typedef enum _SbgEComSyncInId	SbgEComSyncInId
typedef enum _SbgEComSyncInSensitivity	SbgEComSyncInSensitivity
typedef enum _SbgEComSyncOutId	SbgEComSyncOutId
typedef enum _SbgEComSyncOutFunction	SbgEComSyncOutFunction
typedef enum _SbgEComSyncOutPolarity	SbgEComSyncOutPolarity
typedef struct _SbgEComSyncInConf	SbgEComSyncInConf
typedef struct _SbgEComSyncOutConf	SbgEComSyncOutConf

Enumerations
enum	_SbgEComSyncInId {   SBG_ECOM_SYNC_IN_A = 0 ,   SBG_ECOM_SYNC_IN_B = 1 ,   SBG_ECOM_SYNC_IN_C = 2 ,   SBG_ECOM_SYNC_IN_D = 3 }
enum	_SbgEComSyncInSensitivity {   SBG_ECOM_SYNC_IN_DISABLED = 0 ,   SBG_ECOM_SYNC_IN_FALLING_EDGE = 1 ,   SBG_ECOM_SYNC_IN_RISING_EDGE = 2 ,   SBG_ECOM_SYNC_IN_BOTH_EDGES = 3 }
enum	_SbgEComSyncOutId {   SBG_ECOM_SYNC_OUT_A = 0 ,   SBG_ECOM_SYNC_OUT_B = 1 }
enum	_SbgEComSyncOutFunction {   SBG_ECOM_SYNC_OUT_MODE_DISABLED = 0 ,   SBG_ECOM_SYNC_OUT_MODE_MAIN_LOOP = 1 ,   SBG_ECOM_SYNC_OUT_MODE_DIV_2 = 2 ,   SBG_ECOM_SYNC_OUT_MODE_DIV_4 = 4 ,   SBG_ECOM_SYNC_OUT_MODE_DIV_8 = 8 ,   SBG_ECOM_SYNC_OUT_MODE_DIV_10 = 10 ,   SBG_ECOM_SYNC_OUT_MODE_DIV_20 = 20 ,   SBG_ECOM_SYNC_OUT_MODE_DIV_40 = 40 ,   SBG_ECOM_SYNC_OUT_MODE_DIV_200 = 200 ,   SBG_ECOM_SYNC_OUT_MODE_PPS = 10000 ,   SBG_ECOM_SYNC_OUT_MODE_EVENT_IN_A = 10003 ,   SBG_ECOM_SYNC_OUT_MODE_EVENT_IN_B = 10004 ,   SBG_ECOM_SYNC_OUT_MODE_EVENT_IN_C = 10005 ,   SBG_ECOM_SYNC_OUT_MODE_EVENT_IN_D = 10006 ,   SBG_ECOM_SYNC_OUT_MODE_DIRECT_PPS = 10100 }
enum	_SbgEComSyncOutPolarity {   SBG_ECOM_SYNC_OUT_FALLING_EDGE = 0 ,   SBG_ECOM_SYNC_OUT_RISING_EDGE = 1 ,   SBG_ECOM_SYNC_OUT_TOGGLE = 2 }

Functions
SbgErrorCode	sbgEComCmdSyncInGetConf (SbgEComHandle *pHandle, SbgEComSyncInId syncInId, SbgEComSyncInConf *pConf)
SbgErrorCode	sbgEComCmdSyncInSetConf (SbgEComHandle *pHandle, SbgEComSyncInId syncInId, const SbgEComSyncInConf *pConf)
SbgErrorCode	sbgEComCmdSyncOutGetConf (SbgEComHandle *pHandle, SbgEComSyncOutId syncOutId, SbgEComSyncOutConf *pConf)
SbgErrorCode	sbgEComCmdSyncOutSetConf (SbgEComHandle *pHandle, SbgEComSyncOutId syncOutId, const SbgEComSyncOutConf *pConf)

Detailed Description

Input/output event markers configuration commands.

Author

SBG Systems

Date

11 June 2014

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.

Typedef Documentation

SbgEComSyncInId

typedef enum _SbgEComSyncInId SbgEComSyncInId

List of sync in signals available.

SbgEComSyncInSensitivity

typedef enum _SbgEComSyncInSensitivity SbgEComSyncInSensitivity

List of available sensitivities for sync in signals.

SbgEComSyncOutId

typedef enum _SbgEComSyncOutId SbgEComSyncOutId

List of sync out signals available.

SbgEComSyncOutFunction

typedef enum _SbgEComSyncOutFunction SbgEComSyncOutFunction

Logic and synchronization output types

SbgEComSyncOutPolarity

typedef enum _SbgEComSyncOutPolarity SbgEComSyncOutPolarity

Logic output polarity

SbgEComSyncInConf

typedef struct _SbgEComSyncInConf SbgEComSyncInConf

Helper structure for sync in configuration.

SbgEComSyncOutConf

typedef struct _SbgEComSyncOutConf SbgEComSyncOutConf

Helper structure for sync out configuration.

Enumeration Type Documentation

_SbgEComSyncInId

enum _SbgEComSyncInId

List of sync in signals available.

Enumerator
SBG_ECOM_SYNC_IN_A	Sync IN A
SBG_ECOM_SYNC_IN_B	Sync IN B
SBG_ECOM_SYNC_IN_C	Sync IN C
SBG_ECOM_SYNC_IN_D	Sync IN D

_SbgEComSyncInSensitivity

enum _SbgEComSyncInSensitivity

List of available sensitivities for sync in signals.

Enumerator
SBG_ECOM_SYNC_IN_DISABLED	This trigger is turned OFF.
SBG_ECOM_SYNC_IN_FALLING_EDGE	The trigger will be activated by a falling edge.
SBG_ECOM_SYNC_IN_RISING_EDGE	The trigger will be activated by a rising edge.
SBG_ECOM_SYNC_IN_BOTH_EDGES	The trigger is activated by a level change (rising or falling edge).

_SbgEComSyncOutId

enum _SbgEComSyncOutId

List of sync out signals available.

Enumerator
SBG_ECOM_SYNC_OUT_A	Synchronization output A
SBG_ECOM_SYNC_OUT_B	Synchronization output B

_SbgEComSyncOutFunction

enum _SbgEComSyncOutFunction

Logic and synchronization output types

Enumerator
SBG_ECOM_SYNC_OUT_MODE_DISABLED	Output is disabled.
SBG_ECOM_SYNC_OUT_MODE_MAIN_LOOP	Output is generated at 200Hz.
SBG_ECOM_SYNC_OUT_MODE_DIV_2	Output is generated at 100Hz.
SBG_ECOM_SYNC_OUT_MODE_DIV_4	Output is generated at 50Hz.
SBG_ECOM_SYNC_OUT_MODE_DIV_8	Output is generated at 25Hz.
SBG_ECOM_SYNC_OUT_MODE_DIV_10	Output is generated at 20Hz.
SBG_ECOM_SYNC_OUT_MODE_DIV_20	Output is generated at 10Hz.
SBG_ECOM_SYNC_OUT_MODE_DIV_40	Output is generated at 5Hz.
SBG_ECOM_SYNC_OUT_MODE_DIV_200	Output is generated at 1Hz.
SBG_ECOM_SYNC_OUT_MODE_PPS	Pulse Per Second. Same mode as above.
SBG_ECOM_SYNC_OUT_MODE_EVENT_IN_A	Output is generated on a Sync In A event.
SBG_ECOM_SYNC_OUT_MODE_EVENT_IN_B	Output is generated on a Sync In B event.
SBG_ECOM_SYNC_OUT_MODE_EVENT_IN_C	Output is generated on a Sync In C event.
SBG_ECOM_SYNC_OUT_MODE_EVENT_IN_D	Output is generated on a Sync In D event.
SBG_ECOM_SYNC_OUT_MODE_DIRECT_PPS	The internal GNSS PPS signal is directly routed to the Sync Out. This mode is only valid for the following products: ELLIPSE-N with hardware revisions above 1.2.1.0 ELLIPSE-N & ELLIPSE-D Generation 3 or above. Polarity and duration parameters are ignored with this specific mode.

_SbgEComSyncOutPolarity

enum _SbgEComSyncOutPolarity

Logic output polarity

Enumerator
SBG_ECOM_SYNC_OUT_FALLING_EDGE	The output pin will generate a falling edge
SBG_ECOM_SYNC_OUT_RISING_EDGE	The output pin will generate a rising edge
SBG_ECOM_SYNC_OUT_TOGGLE	The pulse is a level change

Function Documentation

sbgEComCmdSyncInGetConf()

SbgErrorCode sbgEComCmdSyncInGetConf	(	SbgEComHandle *	pHandle,
		SbgEComSyncInId	syncInId,
		SbgEComSyncInConf *	pConf
	)

Retrieve the configuration of a Sync In.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	syncInId	The id of the sync whose configuration is to be retrieved.
[out]	pConf	Pointer to a SbgEComSyncInConf to contain the current configuration of the sync in.

Returns

SBG_NO_ERROR if the command has been executed successfully.

sbgEComCmdSyncInSetConf()

SbgErrorCode sbgEComCmdSyncInSetConf	(	SbgEComHandle *	pHandle,
		SbgEComSyncInId	syncInId,
		const SbgEComSyncInConf *	pConf
	)

Set the configuration of a Sync In.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	syncInId	The id of the sync whose configuration is to be set.
[in]	pConf	Pointer to a SbgEComSyncInConf that contains the new configuration for the sync in.

Returns

SBG_NO_ERROR if the command has been executed successfully.

sbgEComCmdSyncOutGetConf()

SbgErrorCode sbgEComCmdSyncOutGetConf	(	SbgEComHandle *	pHandle,
		SbgEComSyncOutId	syncOutId,
		SbgEComSyncOutConf *	pConf
	)

Retrieve the configuration of a Sync Out.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	syncOutId	The id of the sync whose configuration is to be retrieved.
[out]	pConf	Pointer to a SbgEComSyncOutConf to contain the current configuration of the sync out.

Returns

SBG_NO_ERROR if the command has been executed successfully.

sbgEComCmdSyncOutSetConf()

SbgErrorCode sbgEComCmdSyncOutSetConf	(	SbgEComHandle *	pHandle,
		SbgEComSyncOutId	syncOutId,
		const SbgEComSyncOutConf *	pConf
	)

Set the configuration of a Sync Out.

Parameters

[in]	pHandle	A valid sbgECom handle.
[in]	syncOutId	The id of the sync whose configuration is to be set.
[in]	pConf	Pointer to a SbgEComSyncOutConf that contains the new configuration for the sync Out.

Returns

SBG_NO_ERROR if the command has been executed successfully.