mbgtools-lx  4.2.8
mbgextio functions used to check if a particular feature is supported

Functions

int mbgextio_dev_is_legacy (const MBG_MSG_CTL *pmctl)
 Check if a device is a legacy device. More...
 
int mbgextio_dev_has_gps_stat_info (const MBG_MSG_CTL *pmctl)
 Check if a device supports the STAT_INFO structure and API. More...
 
int mbgextio_dev_is_gps (const MBG_MSG_CTL *pmctl)
 Check if a device can receive the GPS satellite system. More...
 
int mbgextio_dev_is_gnss (const MBG_MSG_CTL *pmctl)
 Check if a device supports the GNSS API. More...
 
int mbgextio_dev_is_tcr (const MBG_MSG_CTL *pmctl)
 Check if a device is a time code receiver(TCR) More...
 
int mbgextio_dev_is_dcf (const MBG_MSG_CTL *pmctl)
 Check if a device is a DCF77 receiver. More...
 
int mbgextio_dev_has_pzf (const MBG_MSG_CTL *pmctl)
 Check if a device supports DCF77 PZF decoding. More...
 
int mbgextio_dev_is_bus_lvl_dev (const MBG_MSG_CTL *pmctl)
 Check if a device is a bus level device. More...
 
int mbgextio_dev_has_scu_stat (const MBG_MSG_CTL *pmctl)
 Check if the device supports the SCU_STAT structures. More...
 
int mbgextio_dev_has_raw_irig_data (const MBG_MSG_CTL *pmctl)
 Check if a timecode receiver provides MBG_RAW_IRIG_DATA. More...
 
int mbgextio_dev_has_lan_ip4 (const MBG_MSG_CTL *pmctl)
 Check if a device supports the old LAN_IP4 API. More...
 
int mbgextio_dev_has_net_cfg (const MBG_MSG_CTL *pmctl)
 Check if a device supports the new NET_CFG API. More...
 
int mbgextio_dev_has_ptp (const MBG_MSG_CTL *pmctl)
 Check if a device supports the PTP API. More...
 
int mbgextio_dev_has_ntp (const MBG_MSG_CTL *pmctl)
 Check if a device supports the NTP API. More...
 
int mbgextio_dev_has_fw_mngmnt (const MBG_MSG_CTL *pmctl)
 Check if a device supports the FW management API. More...
 
int mbgextio_dev_has_tlv_api (const MBG_MSG_CTL *pmctl)
 Check if a device supports the TLV API. More...
 
int mbgextio_dev_has_user_auth (const MBG_MSG_CTL *pmctl)
 Check if a device supports user authentication. More...
 
int mbgextio_dev_has_user_mngmnt (const MBG_MSG_CTL *pmctl)
 Check if a device supports user management. More...
 
int mbgextio_dev_supp_tlv_file_req (const MBG_MSG_CTL *pmctl)
 Check if a device supports file request via TLV. More...
 
int mbgextio_dev_supp_tlv_exec_cmd (const MBG_MSG_CTL *pmctl)
 Check if a device supports command execution via TLV. More...
 
int mbgextio_dev_supp_tlv_fw_rollback (const MBG_MSG_CTL *pmctl)
 Check if a device supports a factory reset via TLV. More...
 
int mbgextio_dev_supp_tlv_fw_update (const MBG_MSG_CTL *pmctl)
 Check if a device supports a firmware update via TLV. More...
 
int mbgextio_dev_supp_tlv_diag_file (const MBG_MSG_CTL *pmctl)
 Check if a device supports creating / sending a diagnostics file via TLV. More...
 
int mbgextio_dev_supp_tlv_ptpv2_license (const MBG_MSG_CTL *pmctl)
 Check if a device supports upports PTPv2 license infos. More...
 
int mbgextio_dev_supp_tlv_ptpv1_license (const MBG_MSG_CTL *pmctl)
 Check if a device supports supports PTPv1 License Infos via TLV. More...
 
int mbgextio_dev_supp_tlv_ntp_license (const MBG_MSG_CTL *pmctl)
 Check if a device supports supports NTP license infos via TLV. More...
 
int mbgextio_dev_supp_tlv_time_monitor_license (const MBG_MSG_CTL *pmctl)
 Check if a device supports supportsTime Monitor License infos via TLV. More...
 
int mbgextio_dev_supp_tlv_ufu (const MBG_MSG_CTL *pmctl)
 Check if a device supports a UFU (Unified Firmware Update) via TLV. More...
 
int mbgextio_dev_has_cmd_save_cfg (const MBG_MSG_CTL *pmctl)
 Check if a device supports the GPS_SAVE_CFG command. More...
 
int mbgextio_dev_has_monitoring (const MBG_MSG_CTL *pmctl)
 Check if a device supports the extended feature monitoring. More...
 
int mbgextio_dev_has_led_api (const MBG_MSG_CTL *pmctl)
 Check if a device supports the LED API. More...
 
int mbgextio_dev_has_lne_api (const MBG_MSG_CTL *pmctl)
 Check if a device supports the LNE API. More...
 
int mbgextio_dev_has_pwr_ctl_api (const MBG_MSG_CTL *pmctl)
 Check if a device supports the power control API. More...
 
int mbgextio_dev_has_ext_sys_info (const MBG_MSG_CTL *pmctl)
 Check if a device has MBG_XFEATURE_EXT_SYS_INFO. More...
 
int mbgextio_dev_has_transactions (const MBG_MSG_CTL *pmctl)
 Check if a device has MBG_XFEATURE_TRANSACTIONS. More...
 
int mbgextio_dev_has_reboot (const MBG_MSG_CTL *pmctl)
 Check if a device has MBG_XFEATURE_REBOOT. More...
 
int mbgextio_dev_has_req_ttm (const MBG_MSG_CTL *pmctl)
 Check if a device has MBG_XFEATURE_REQ_TTM. More...
 
int mbgextio_dev_has_xmulti_ref (const MBG_MSG_CTL *pmctl)
 Check if a device supports the up-to-date extended multi ref API. More...
 
int mbgextio_dev_has_xbp (const MBG_MSG_CTL *pmctl)
 Check if a device supports the extended binary protocl (XBP) feature. More...
 
int mbgextio_dev_has_database (const MBG_MSG_CTL *pmctl)
 Check if a device supports database(s) feature. More...
 
int mbgextio_dev_has_gnss_mode (const MBG_MSG_CTL *pmctl)
 Check if a device supports GNSS mode feature All GNSS receivers support this feature by default, this is for GPS-only devices. More...
 

Variables

MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_is_legacy
 Check if a device is a legacy device. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_gps_stat_info
 Check if a device supports the STAT_INFO structure and API. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_is_gps
 Check if a device can receive the GPS satellite system. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_is_gnss
 Check if a device supports the GNSS API. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_is_tcr
 Check if a device is a time code receiver(TCR) More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_is_dcf
 Check if a device is a DCF77 receiver. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_pzf
 Check if a device supports DCF77 PZF decoding. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_is_bus_lvl_dev
 Check if a device is a bus level device. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_scu_stat
 Check if the device supports the SCU_STAT structures. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_raw_irig_data
 Check if a timecode receiver provides MBG_RAW_IRIG_DATA. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_lan_ip4
 Check if a device supports the old LAN_IP4 API. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_net_cfg
 Check if a device supports the new NET_CFG API. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_ptp
 Check if a device supports the PTP API. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_ntp
 Check if a device supports the NTP API. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_fw_mngmnt
 Check if a device supports the FW management API. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_tlv_api
 Check if a device supports the TLV API. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_user_auth
 Check if a device supports user authentication. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_user_mngmnt
 Check if a device supports user management. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_supp_tlv_file_req
 Check if a device supports file request via TLV. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_supp_tlv_exec_cmd
 Check if a device supports command execution via TLV. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_supp_tlv_fw_rollback
 Check if a device supports a factory reset via TLV. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_supp_tlv_fw_update
 Check if a device supports a firmware update via TLV. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_supp_tlv_diag_file
 Check if a device supports creating / sending a diagnostics file via TLV. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_supp_tlv_ptpv2_license
 Check if a device supports upports PTPv2 license infos. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_supp_tlv_ptpv1_license
 Check if a device supports supports PTPv1 License Infos via TLV. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_supp_tlv_ntp_license
 Check if a device supports supports NTP license infos via TLV. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_supp_tlv_time_monitor_license
 Check if a device supports supportsTime Monitor License infos via TLV. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_supp_tlv_ufu
 Check if a device supports a UFU (Unified Firmware Update) via TLV. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_cmd_save_cfg
 Check if a device supports the GPS_SAVE_CFG command. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_monitoring
 Check if a device supports the extended feature monitoring. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_led_api
 Check if a device supports the LED API. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_lne_api
 Check if a device supports the LNE API. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_pwr_ctl_api
 Check if a device supports the power control API. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_ext_sys_info
 Check if a device has MBG_XFEATURE_EXT_SYS_INFO. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_transactions
 Check if a device has MBG_XFEATURE_TRANSACTIONS. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_reboot
 Check if a device has MBG_XFEATURE_REBOOT. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_req_ttm
 Check if a device has MBG_XFEATURE_REQ_TTM. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_xmulti_ref
 Check if a device supports the up-to-date extended multi ref API. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_xbp
 Check if a device supports the extended binary protocl (XBP) feature. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_database
 Check if a device supports database(s) feature. More...
 
MBGEXTIO_CHK_SUPP_FNC mbgextio_dev_has_gnss_mode
 Check if a device supports GNSS mode feature All GNSS receivers support this feature by default, this is for GPS-only devices. More...
 

Detailed Description

Each of these functions can be used to check if a device supports a particular feature. MBG_SUCCESS is returned if the requested feature is supported, otherwise one of the MBG_ERROR_CODES is returned, as appropriate.

Function Documentation

◆ mbgextio_dev_has_cmd_save_cfg()

int mbgextio_dev_has_cmd_save_cfg ( const MBG_MSG_CTL pmctl)

Check if a device supports the GPS_SAVE_CFG command.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
mbgextio_cmd_save_cfg
mbgextio functions used to check if a particular feature is supported

Definition at line 4267 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_cmd_save_cfg.

◆ mbgextio_dev_has_database()

int mbgextio_dev_has_database ( const MBG_MSG_CTL pmctl)

Check if a device supports database(s) feature.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4509 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_database.

◆ mbgextio_dev_has_ext_sys_info()

int mbgextio_dev_has_ext_sys_info ( const MBG_MSG_CTL pmctl)

Check if a device has MBG_XFEATURE_EXT_SYS_INFO.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4377 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_ext_sys_info.

◆ mbgextio_dev_has_fw_mngmnt()

int mbgextio_dev_has_fw_mngmnt ( const MBG_MSG_CTL pmctl)

Check if a device supports the FW management API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio_get_all_firmware_info
mbgextio_get_fw_glb_info
mbgextio_get_fw_info_idx
mbgextio_get_fw_ufu_info_idx
mbgextio functions used to check if a particular feature is supported

Definition at line 3930 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_fw_mngmnt.

◆ mbgextio_dev_has_gnss_mode()

int mbgextio_dev_has_gnss_mode ( const MBG_MSG_CTL pmctl)

Check if a device supports GNSS mode feature All GNSS receivers support this feature by default, this is for GPS-only devices.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4532 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_gnss_mode.

◆ mbgextio_dev_has_gps_stat_info()

int mbgextio_dev_has_gps_stat_info ( const MBG_MSG_CTL pmctl)

Check if a device supports the STAT_INFO structure and API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3449 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_gps_stat_info.

◆ mbgextio_dev_has_lan_ip4()

int mbgextio_dev_has_lan_ip4 ( const MBG_MSG_CTL pmctl)

Check if a device supports the old LAN_IP4 API.

The LAN_IP4 API provides structures and functions to configure parts of the networking of a device and is superseded by the NET_CFG API. Some devices combine NET_CFG and LAN_IP4. Therefore, mbgextio_get_all_net_cfg_info should be used preferably to read the network configuration. It will translate the old structures into the new ones.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio_get_all_net_cfg_info
mbgextio functions used to check if a particular feature is supported

Definition at line 3824 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_lan_ip4.

◆ mbgextio_dev_has_led_api()

int mbgextio_dev_has_led_api ( const MBG_MSG_CTL pmctl)

Check if a device supports the LED API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
::TODO ###
mbgextio functions used to check if a particular feature is supported

Definition at line 4311 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_led_api.

◆ mbgextio_dev_has_lne_api()

int mbgextio_dev_has_lne_api ( const MBG_MSG_CTL pmctl)

Check if a device supports the LNE API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
::TODO ###
mbgextio functions used to check if a particular feature is supported

Definition at line 4333 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_lne_api.

◆ mbgextio_dev_has_monitoring()

int mbgextio_dev_has_monitoring ( const MBG_MSG_CTL pmctl)

Check if a device supports the extended feature monitoring.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
xdevfeat_has_monitoring
mbgextio functions used to check if a particular feature is supported

Definition at line 4289 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_monitoring.

◆ mbgextio_dev_has_net_cfg()

int mbgextio_dev_has_net_cfg ( const MBG_MSG_CTL pmctl)

Check if a device supports the new NET_CFG API.

The NET_CFG API provides structures and functions to configure the complete networking part of a device and supersedes the LAN_IP4 API. Not all devices support the whole feature set of the NET_CFG API or combine NET_CFG and LAN_IP4. Therefore, mbgextio_get_all_net_cfg_info should be used preferably to read the network configuration.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio_get_all_net_cfg_info
mbgextio functions used to check if a particular feature is supported

Definition at line 3853 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_net_cfg.

◆ mbgextio_dev_has_ntp()

int mbgextio_dev_has_ntp ( const MBG_MSG_CTL pmctl)

Check if a device supports the NTP API.

The NTP API consists of different calls and associated structures which have evolved over time. Not all devices support every call, so mbgextio_get_all_ntp_cfg_info takes care to check which parts are supported and thus should be used preferably to read NTP information.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio_get_all_ntp_cfg_info
mbgextio functions used to check if a particular feature is supported

Definition at line 3906 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_ntp.

◆ mbgextio_dev_has_ptp()

int mbgextio_dev_has_ptp ( const MBG_MSG_CTL pmctl)

Check if a device supports the PTP API.

The PTP API consists of different calls and associated structures which * have evolved over time. Not all devices support every call, so mbgextio_get_all_ptp_cfg_info takes care to check which parts are supported and thus should be used preferably to read PTP information.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio_get_all_ptp_cfg_info
mbgextio functions used to check if a particular feature is supported

Definition at line 3880 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_ptp.

◆ mbgextio_dev_has_pwr_ctl_api()

int mbgextio_dev_has_pwr_ctl_api ( const MBG_MSG_CTL pmctl)

Check if a device supports the power control API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
::TODO ###
mbgextio functions used to check if a particular feature is supported

Definition at line 4355 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_pwr_ctl_api.

◆ mbgextio_dev_has_pzf()

int mbgextio_dev_has_pzf ( const MBG_MSG_CTL pmctl)

Check if a device supports DCF77 PZF decoding.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3564 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_pzf.

◆ mbgextio_dev_has_raw_irig_data()

int mbgextio_dev_has_raw_irig_data ( const MBG_MSG_CTL pmctl)

Check if a timecode receiver provides MBG_RAW_IRIG_DATA.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio_get_raw_irig_data
mbgextio functions used to check if a particular feature is supported

Definition at line 3795 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_raw_irig_data.

◆ mbgextio_dev_has_reboot()

int mbgextio_dev_has_reboot ( const MBG_MSG_CTL pmctl)

Check if a device has MBG_XFEATURE_REBOOT.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4421 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_reboot.

◆ mbgextio_dev_has_req_ttm()

int mbgextio_dev_has_req_ttm ( const MBG_MSG_CTL pmctl)

Check if a device has MBG_XFEATURE_REQ_TTM.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported
mbgextio_get_time

Definition at line 4444 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_req_ttm.

◆ mbgextio_dev_has_scu_stat()

int mbgextio_dev_has_scu_stat ( const MBG_MSG_CTL pmctl)

Check if the device supports the SCU_STAT structures.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio functions used to check if a particular feature is supported
mbgextio_get_scu_stat_info
mbgextio_set_scu_stat_settings
Definitions used with SCU devices

Definition at line 3774 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_scu_stat.

◆ mbgextio_dev_has_tlv_api()

int mbgextio_dev_has_tlv_api ( const MBG_MSG_CTL pmctl)

Check if a device supports the TLV API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
Meinberg TLV API definitions
mbgextio functions used to check if a particular feature is supported

Definition at line 3981 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_tlv_api.

◆ mbgextio_dev_has_transactions()

int mbgextio_dev_has_transactions ( const MBG_MSG_CTL pmctl)

Check if a device has MBG_XFEATURE_TRANSACTIONS.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4399 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_transactions.

◆ mbgextio_dev_has_user_auth()

int mbgextio_dev_has_user_auth ( const MBG_MSG_CTL pmctl)

Check if a device supports user authentication.

The GPS_AUTH_USER_INFO and GPS_AUTH_USER_STATUS commands can be used to get the current user information.

Although the feature might be set, user authentication is only used via encrypted SSH, so the conn. type has to be checked as well

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4007 of file mbgextio.c.

References MBG_MSG_CTL_s::conn_type, MBG_CONN_TYPE_SOCKET, MBG_ERR_CONN_TYPE, MBG_MSG_CTL_s::st, MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_user_auth.

◆ mbgextio_dev_has_user_mngmnt()

int mbgextio_dev_has_user_mngmnt ( const MBG_MSG_CTL pmctl)

Check if a device supports user management.

The GPS_USER_MNGMNT_INFO, GPS_USER_INFO_IDX, GPS_USER_LEVEL_INFO_IDX and GPS_USER_STATUS_IDX commands can be used to get the user management information.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4039 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_user_mngmnt.

◆ mbgextio_dev_has_xbp()

int mbgextio_dev_has_xbp ( const MBG_MSG_CTL pmctl)

Check if a device supports the extended binary protocl (XBP) feature.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4487 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_xbp.

◆ mbgextio_dev_has_xmulti_ref()

int mbgextio_dev_has_xmulti_ref ( const MBG_MSG_CTL pmctl)

Check if a device supports the up-to-date extended multi ref API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4465 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_has_xmulti_ref.

◆ mbgextio_dev_is_bus_lvl_dev()

int mbgextio_dev_is_bus_lvl_dev ( const MBG_MSG_CTL pmctl)

Check if a device is a bus level device.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3586 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_is_bus_lvl_dev.

◆ mbgextio_dev_is_dcf()

int mbgextio_dev_is_dcf ( const MBG_MSG_CTL pmctl)

Check if a device is a DCF77 receiver.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3542 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_is_dcf.

◆ mbgextio_dev_is_gnss()

int mbgextio_dev_is_gnss ( const MBG_MSG_CTL pmctl)

Check if a device supports the GNSS API.

This is usually supported by devices which can receive signals from different satellite systems, e.g. GPS, GLONASS, ...

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio_chk_get_all_gnss_info
MBG_GNSS_TYPES
mbgextio functions used to check if a particular feature is supported

Definition at line 3498 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_is_gnss.

◆ mbgextio_dev_is_gps()

int mbgextio_dev_is_gps ( const MBG_MSG_CTL pmctl)

Check if a device can receive the GPS satellite system.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3471 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_is_gps.

◆ mbgextio_dev_is_legacy()

int mbgextio_dev_is_legacy ( const MBG_MSG_CTL pmctl)

Check if a device is a legacy device.

Legacy devices don't support the standard binary protocol, so the standard binary API functions must not be used with such a device. Any attempt to access the device using the standard binary API functions may have unpredictable side-effects for the device, but the low level read/write functions can be used to access the device via a proprietary protocol, depending on the device type.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_DEV_NOT_SUPP
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3329 of file mbgextio.c.

References MBG_MSG_CTL_s::device_flags, MBG_ERR_DEV_NOT_SUPP, MBG_SUCCESS, and MSG_CTL_DEVICE_FLAG_MSK_LEGACY.

◆ mbgextio_dev_is_tcr()

int mbgextio_dev_is_tcr ( const MBG_MSG_CTL pmctl)

Check if a device is a time code receiver(TCR)

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3520 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_is_tcr.

◆ mbgextio_dev_supp_tlv_diag_file()

int mbgextio_dev_supp_tlv_diag_file ( const MBG_MSG_CTL pmctl)

Check if a device supports creating / sending a diagnostics file via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
::TODO //refer to get diag function
mbgextio functions used to check if a particular feature is supported

Definition at line 4144 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_supp_tlv_diag_file.

◆ mbgextio_dev_supp_tlv_exec_cmd()

int mbgextio_dev_supp_tlv_exec_cmd ( const MBG_MSG_CTL pmctl)

Check if a device supports command execution via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
mbgextio_xmt_cmd_line
mbgextio functions used to check if a particular feature is supported

Definition at line 4082 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_supp_tlv_exec_cmd.

◆ mbgextio_dev_supp_tlv_file_req()

int mbgextio_dev_supp_tlv_file_req ( const MBG_MSG_CTL pmctl)

Check if a device supports file request via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
mbgextio_req_file
mbgextio functions used to check if a particular feature is supported

Definition at line 4060 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_supp_tlv_file_req.

◆ mbgextio_dev_supp_tlv_fw_rollback()

int mbgextio_dev_supp_tlv_fw_rollback ( const MBG_MSG_CTL pmctl)

Check if a device supports a factory reset via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
mbgextio_xmt_fw_rollback
mbgextio functions used to check if a particular feature is supported

Definition at line 4104 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_supp_tlv_fw_rollback.

◆ mbgextio_dev_supp_tlv_fw_update()

int mbgextio_dev_supp_tlv_fw_update ( const MBG_MSG_CTL pmctl)

Check if a device supports a firmware update via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
::TODO //refer to fw update function
mbgextio functions used to check if a particular feature is supported

Definition at line 4124 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_supp_tlv_fw_update.

◆ mbgextio_dev_supp_tlv_ntp_license()

int mbgextio_dev_supp_tlv_ntp_license ( const MBG_MSG_CTL pmctl)

Check if a device supports supports NTP license infos via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
::TODO //refer to get diag function
mbgextio functions used to check if a particular feature is supported

Definition at line 4205 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_supp_tlv_ntp_license.

◆ mbgextio_dev_supp_tlv_ptpv1_license()

int mbgextio_dev_supp_tlv_ptpv1_license ( const MBG_MSG_CTL pmctl)

Check if a device supports supports PTPv1 License Infos via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
::TODO //refer to get diag function
mbgextio functions used to check if a particular feature is supported

Definition at line 4184 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_supp_tlv_ptpv1_license.

◆ mbgextio_dev_supp_tlv_ptpv2_license()

int mbgextio_dev_supp_tlv_ptpv2_license ( const MBG_MSG_CTL pmctl)

Check if a device supports upports PTPv2 license infos.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
::TODO //refer to get diag function
mbgextio functions used to check if a particular feature is supported

Definition at line 4164 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_supp_tlv_ptpv2_license.

◆ mbgextio_dev_supp_tlv_time_monitor_license()

int mbgextio_dev_supp_tlv_time_monitor_license ( const MBG_MSG_CTL pmctl)

Check if a device supports supportsTime Monitor License infos via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
::TODO //refer to get diag function
mbgextio functions used to check if a particular feature is supported

Definition at line 4226 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_supp_tlv_time_monitor_license.

◆ mbgextio_dev_supp_tlv_ufu()

int mbgextio_dev_supp_tlv_ufu ( const MBG_MSG_CTL pmctl)

Check if a device supports a UFU (Unified Firmware Update) via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4246 of file mbgextio.c.

References MBG_MSG_CTL_s::xdev_features, and xdevfeat_supp_tlv_ufu.

Variable Documentation

◆ mbgextio_dev_has_cmd_save_cfg

int mbgextio_dev_has_cmd_save_cfg

Check if a device supports the GPS_SAVE_CFG command.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
mbgextio_cmd_save_cfg
mbgextio functions used to check if a particular feature is supported

Definition at line 4273 of file mbgextio.c.

◆ mbgextio_dev_has_database

int mbgextio_dev_has_database

Check if a device supports database(s) feature.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4515 of file mbgextio.c.

◆ mbgextio_dev_has_ext_sys_info

int mbgextio_dev_has_ext_sys_info

Check if a device has MBG_XFEATURE_EXT_SYS_INFO.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4383 of file mbgextio.c.

◆ mbgextio_dev_has_fw_mngmnt

int mbgextio_dev_has_fw_mngmnt

Check if a device supports the FW management API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio_get_all_firmware_info
mbgextio_get_fw_glb_info
mbgextio_get_fw_info_idx
mbgextio_get_fw_ufu_info_idx
mbgextio functions used to check if a particular feature is supported

Definition at line 3936 of file mbgextio.c.

◆ mbgextio_dev_has_gnss_mode

int mbgextio_dev_has_gnss_mode

Check if a device supports GNSS mode feature All GNSS receivers support this feature by default, this is for GPS-only devices.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4538 of file mbgextio.c.

◆ mbgextio_dev_has_gps_stat_info

int mbgextio_dev_has_gps_stat_info

Check if a device supports the STAT_INFO structure and API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3455 of file mbgextio.c.

◆ mbgextio_dev_has_lan_ip4

int mbgextio_dev_has_lan_ip4

Check if a device supports the old LAN_IP4 API.

The LAN_IP4 API provides structures and functions to configure parts of the networking of a device and is superseded by the NET_CFG API. Some devices combine NET_CFG and LAN_IP4. Therefore, mbgextio_get_all_net_cfg_info should be used preferably to read the network configuration. It will translate the old structures into the new ones.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio_get_all_net_cfg_info
mbgextio functions used to check if a particular feature is supported

Definition at line 3830 of file mbgextio.c.

◆ mbgextio_dev_has_led_api

int mbgextio_dev_has_led_api

Check if a device supports the LED API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
::TODO ###
mbgextio functions used to check if a particular feature is supported

Definition at line 4317 of file mbgextio.c.

◆ mbgextio_dev_has_lne_api

int mbgextio_dev_has_lne_api

Check if a device supports the LNE API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
::TODO ###
mbgextio functions used to check if a particular feature is supported

Definition at line 4339 of file mbgextio.c.

◆ mbgextio_dev_has_monitoring

int mbgextio_dev_has_monitoring

Check if a device supports the extended feature monitoring.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
xdevfeat_has_monitoring
mbgextio functions used to check if a particular feature is supported

Definition at line 4295 of file mbgextio.c.

◆ mbgextio_dev_has_net_cfg

int mbgextio_dev_has_net_cfg

Check if a device supports the new NET_CFG API.

The NET_CFG API provides structures and functions to configure the complete networking part of a device and supersedes the LAN_IP4 API. Not all devices support the whole feature set of the NET_CFG API or combine NET_CFG and LAN_IP4. Therefore, mbgextio_get_all_net_cfg_info should be used preferably to read the network configuration.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio_get_all_net_cfg_info
mbgextio functions used to check if a particular feature is supported

Definition at line 3859 of file mbgextio.c.

◆ mbgextio_dev_has_ntp

int mbgextio_dev_has_ntp

Check if a device supports the NTP API.

The NTP API consists of different calls and associated structures which have evolved over time. Not all devices support every call, so mbgextio_get_all_ntp_cfg_info takes care to check which parts are supported and thus should be used preferably to read NTP information.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio_get_all_ntp_cfg_info
mbgextio functions used to check if a particular feature is supported

Definition at line 3912 of file mbgextio.c.

◆ mbgextio_dev_has_ptp

int mbgextio_dev_has_ptp

Check if a device supports the PTP API.

The PTP API consists of different calls and associated structures which * have evolved over time. Not all devices support every call, so mbgextio_get_all_ptp_cfg_info takes care to check which parts are supported and thus should be used preferably to read PTP information.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio_get_all_ptp_cfg_info
mbgextio functions used to check if a particular feature is supported

Definition at line 3886 of file mbgextio.c.

◆ mbgextio_dev_has_pwr_ctl_api

int mbgextio_dev_has_pwr_ctl_api

Check if a device supports the power control API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
::TODO ###
mbgextio functions used to check if a particular feature is supported

Definition at line 4361 of file mbgextio.c.

◆ mbgextio_dev_has_pzf

int mbgextio_dev_has_pzf

Check if a device supports DCF77 PZF decoding.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3570 of file mbgextio.c.

◆ mbgextio_dev_has_raw_irig_data

int mbgextio_dev_has_raw_irig_data

Check if a timecode receiver provides MBG_RAW_IRIG_DATA.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio_get_raw_irig_data
mbgextio functions used to check if a particular feature is supported

Definition at line 3801 of file mbgextio.c.

◆ mbgextio_dev_has_reboot

int mbgextio_dev_has_reboot

Check if a device has MBG_XFEATURE_REBOOT.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4427 of file mbgextio.c.

◆ mbgextio_dev_has_req_ttm

int mbgextio_dev_has_req_ttm

Check if a device has MBG_XFEATURE_REQ_TTM.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported
mbgextio_get_time

Definition at line 4450 of file mbgextio.c.

◆ mbgextio_dev_has_scu_stat

int mbgextio_dev_has_scu_stat

Check if the device supports the SCU_STAT structures.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_ri_feature
See also
mbgextio functions used to check if a particular feature is supported
mbgextio_get_scu_stat_info
mbgextio_set_scu_stat_settings
Definitions used with SCU devices

Definition at line 3780 of file mbgextio.c.

◆ mbgextio_dev_has_tlv_api

int mbgextio_dev_has_tlv_api

Check if a device supports the TLV API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
Meinberg TLV API definitions
mbgextio functions used to check if a particular feature is supported

Definition at line 3987 of file mbgextio.c.

◆ mbgextio_dev_has_transactions

int mbgextio_dev_has_transactions

Check if a device has MBG_XFEATURE_TRANSACTIONS.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4405 of file mbgextio.c.

◆ mbgextio_dev_has_user_auth

int mbgextio_dev_has_user_auth

Check if a device supports user authentication.

The GPS_AUTH_USER_INFO and GPS_AUTH_USER_STATUS commands can be used to get the current user information.

Although the feature might be set, user authentication is only used via encrypted SSH, so the conn. type has to be checked as well

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4021 of file mbgextio.c.

Referenced by mbgextio_chk_user_perm(), and mbgextio_setup_xdevfeat().

◆ mbgextio_dev_has_user_mngmnt

int mbgextio_dev_has_user_mngmnt

Check if a device supports user management.

The GPS_USER_MNGMNT_INFO, GPS_USER_INFO_IDX, GPS_USER_LEVEL_INFO_IDX and GPS_USER_STATUS_IDX commands can be used to get the user management information.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_xfeature
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4045 of file mbgextio.c.

◆ mbgextio_dev_has_xbp

int mbgextio_dev_has_xbp

Check if a device supports the extended binary protocl (XBP) feature.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4493 of file mbgextio.c.

◆ mbgextio_dev_has_xmulti_ref

int mbgextio_dev_has_xmulti_ref

Check if a device supports the up-to-date extended multi ref API.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4471 of file mbgextio.c.

◆ mbgextio_dev_is_bus_lvl_dev

int mbgextio_dev_is_bus_lvl_dev

Check if a device is a bus level device.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3592 of file mbgextio.c.

◆ mbgextio_dev_is_dcf

int mbgextio_dev_is_dcf

Check if a device is a DCF77 receiver.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3548 of file mbgextio.c.

◆ mbgextio_dev_is_gnss

int mbgextio_dev_is_gnss

Check if a device supports the GNSS API.

This is usually supported by devices which can receive signals from different satellite systems, e.g. GPS, GLONASS, ...

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio_chk_get_all_gnss_info
MBG_GNSS_TYPES
mbgextio functions used to check if a particular feature is supported

Definition at line 3504 of file mbgextio.c.

◆ mbgextio_dev_is_gps

int mbgextio_dev_is_gps

Check if a device can receive the GPS satellite system.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3477 of file mbgextio.c.

◆ mbgextio_dev_is_legacy

int mbgextio_dev_is_legacy

Check if a device is a legacy device.

Legacy devices don't support the standard binary protocol, so the standard binary API functions must not be used with such a device. Any attempt to access the device using the standard binary API functions may have unpredictable side-effects for the device, but the low level read/write functions can be used to access the device via a proprietary protocol, depending on the device type.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_DEV_NOT_SUPP
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3335 of file mbgextio.c.

◆ mbgextio_dev_is_tcr

int mbgextio_dev_is_tcr

Check if a device is a time code receiver(TCR)

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else MBG_ERR_NOT_SUPP_BY_DEV or MBG_ERR_DEV_NOT_SUPP (see Low level functions used to check if a particular feature is supported)
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 3526 of file mbgextio.c.

◆ mbgextio_dev_supp_tlv_diag_file

int mbgextio_dev_supp_tlv_diag_file

Check if a device supports creating / sending a diagnostics file via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
::TODO //refer to get diag function
mbgextio functions used to check if a particular feature is supported

Definition at line 4150 of file mbgextio.c.

◆ mbgextio_dev_supp_tlv_exec_cmd

int mbgextio_dev_supp_tlv_exec_cmd

Check if a device supports command execution via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
mbgextio_xmt_cmd_line
mbgextio functions used to check if a particular feature is supported

Definition at line 4088 of file mbgextio.c.

◆ mbgextio_dev_supp_tlv_file_req

int mbgextio_dev_supp_tlv_file_req

Check if a device supports file request via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
mbgextio_req_file
mbgextio functions used to check if a particular feature is supported

Definition at line 4066 of file mbgextio.c.

◆ mbgextio_dev_supp_tlv_fw_rollback

int mbgextio_dev_supp_tlv_fw_rollback

Check if a device supports a factory reset via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
mbgextio_xmt_fw_rollback
mbgextio functions used to check if a particular feature is supported

Definition at line 4110 of file mbgextio.c.

◆ mbgextio_dev_supp_tlv_fw_update

int mbgextio_dev_supp_tlv_fw_update

Check if a device supports a firmware update via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
::TODO //refer to fw update function
mbgextio functions used to check if a particular feature is supported

Definition at line 4130 of file mbgextio.c.

◆ mbgextio_dev_supp_tlv_ntp_license

int mbgextio_dev_supp_tlv_ntp_license

Check if a device supports supports NTP license infos via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
::TODO //refer to get diag function
mbgextio functions used to check if a particular feature is supported

Definition at line 4211 of file mbgextio.c.

◆ mbgextio_dev_supp_tlv_ptpv1_license

int mbgextio_dev_supp_tlv_ptpv1_license

Check if a device supports supports PTPv1 License Infos via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
::TODO //refer to get diag function
mbgextio functions used to check if a particular feature is supported

Definition at line 4190 of file mbgextio.c.

◆ mbgextio_dev_supp_tlv_ptpv2_license

int mbgextio_dev_supp_tlv_ptpv2_license

Check if a device supports upports PTPv2 license infos.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
::TODO //refer to get diag function
mbgextio functions used to check if a particular feature is supported

Definition at line 4170 of file mbgextio.c.

◆ mbgextio_dev_supp_tlv_time_monitor_license

int mbgextio_dev_supp_tlv_time_monitor_license

Check if a device supports supportsTime Monitor License infos via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
::TODO //refer to get diag function
mbgextio functions used to check if a particular feature is supported

Definition at line 4232 of file mbgextio.c.

◆ mbgextio_dev_supp_tlv_ufu

int mbgextio_dev_supp_tlv_ufu

Check if a device supports a UFU (Unified Firmware Update) via TLV.

Parameters
[in,out]pmctlPointer to a valid message control structure
Returns
MBG_SUCCESS if supported, else error code from check_tlv_feat_supp
See also
mbgextio functions used to check if a particular feature is supported

Definition at line 4252 of file mbgextio.c.