Classes | Typedefs | Enumerations | Functions
sbgEComCmdEvent.h File Reference

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

#include "sbgEComCmdCommon.h"
Include dependency graph for sbgEComCmdEvent.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  _SbgEComSyncInConf
 
struct  _SbgEComSyncOutConf
 

Typedefs

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

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  _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  _SbgEComSyncOutId { SBG_ECOM_SYNC_OUT_A = 0, SBG_ECOM_SYNC_OUT_B = 1 }
 
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

This file implements SbgECom commands related to events.

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.

Definition in file sbgEComCmdEvent.h.

Typedef Documentation

◆ SbgEComSyncInConf

Helper structure for sync in configuration.

◆ SbgEComSyncInId

List of sync in signals available.

◆ SbgEComSyncInSensitivity

List of available sensitivities for sync in signals.

◆ SbgEComSyncOutConf

Helper structure for sync out configuration.

◆ SbgEComSyncOutFunction

Logic and synchronization output types

◆ SbgEComSyncOutId

List of sync out signals available.

◆ SbgEComSyncOutPolarity

Logic output polarity

Enumeration Type Documentation

◆ _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

Definition at line 32 of file sbgEComCmdEvent.h.

◆ _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).

Definition at line 43 of file sbgEComCmdEvent.h.

◆ _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 ELLIPSE-N with hardware revisions above 1.2.1.0. Polarity and duration parameters are ignored with this specific mode.

Definition at line 63 of file sbgEComCmdEvent.h.

◆ _SbgEComSyncOutId

List of sync out signals available.

Enumerator
SBG_ECOM_SYNC_OUT_A 

Synchronization output A

SBG_ECOM_SYNC_OUT_B 

Synchronization output B

Definition at line 54 of file sbgEComCmdEvent.h.

◆ _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

Definition at line 89 of file sbgEComCmdEvent.h.

Function Documentation

◆ sbgEComCmdSyncInGetConf()

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

Retrieve the configuration of a Sync In.

Parameters
[in]pHandleA valid sbgECom handle.
[in]syncInIdThe id of the sync whose configuration is to be retrieved.
[out]pConfPointer to a SbgEComSyncInConf to contain the current configuration of the sync in.
Returns
SBG_NO_ERROR if the command has been executed successfully.

Definition at line 15 of file sbgEComCmdEvent.c.

◆ sbgEComCmdSyncInSetConf()

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

Set the configuration of a Sync In.

Parameters
[in]pHandleA valid sbgECom handle.
[in]syncInIdThe id of the sync whose configuration is to be set.
[in]pConfPointer to a SbgEComSyncInConf that contains the new configuration for the sync in.
Returns
SBG_NO_ERROR if the command has been executed successfully.

Definition at line 91 of file sbgEComCmdEvent.c.

◆ sbgEComCmdSyncOutGetConf()

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

Retrieve the configuration of a Sync Out.

Parameters
[in]pHandleA valid sbgECom handle.
[in]syncOutIdThe id of the sync whose configuration is to be retrieved.
[out]pConfPointer to a SbgEComSyncOutConf to contain the current configuration of the sync out.
Returns
SBG_NO_ERROR if the command has been executed successfully.

Definition at line 163 of file sbgEComCmdEvent.c.

◆ sbgEComCmdSyncOutSetConf()

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

Set the configuration of a Sync Out.

Parameters
[in]pHandleA valid sbgECom handle.
[in]syncOutIdThe id of the sync whose configuration is to be set.
[in]pConfPointer to a SbgEComSyncOutConf that contains the new configuration for the sync Out.
Returns
SBG_NO_ERROR if the command has been executed successfully.

Definition at line 241 of file sbgEComCmdEvent.c.



sbg_driver
Author(s): SBG Systems
autogenerated on Sat Sep 3 2022 02:53:36