Functions
sbgEComCmdSettings.c File Reference
#include "sbgEComCmdSettings.h"
#include "transfer/sbgEComTransfer.h"
#include <streamBuffer/sbgStreamBuffer.h>
Include dependency graph for sbgEComCmdSettings.c:

Go to the source code of this file.

Functions

SbgErrorCode sbgEComCmdExportSettings (SbgEComHandle *pHandle, void *pBuffer, size_t *pSize, size_t maxSize)
 
SbgErrorCode sbgEComCmdImportSettings (SbgEComHandle *pHandle, const void *pBuffer, size_t size)
 
SbgErrorCode sbgEComCmdSettingsAction (SbgEComHandle *pHandle, SbgEComSettingsAction action)
 

Function Documentation

◆ sbgEComCmdExportSettings()

SbgErrorCode sbgEComCmdExportSettings ( SbgEComHandle pHandle,
void *  pBuffer,
size_t *  pSize,
size_t  maxSize 
)

Retrieve a complete set of settings from the device as a buffer.

Parameters
[in]pHandleA valid sbgECom handle.
[in]pBufferAllocated buffer that can hold the received settings.
[out]pSizeThe number of bytes that have been stored into pBuffer.
[in]maxSizeThe maximum buffer size in bytes that can be stored into pBuffer.
Returns
SBG_NO_ERROR if the command has been executed successfully.

Definition at line 96 of file sbgEComCmdSettings.c.

◆ sbgEComCmdImportSettings()

SbgErrorCode sbgEComCmdImportSettings ( SbgEComHandle pHandle,
const void *  pBuffer,
size_t  size 
)

Send a complete set of settings to the device and store them into the FLASH memory. The device will reboot automatically to use the new settings.

Parameters
[in]pHandleA valid sbgECom handle.
[in]pBufferRead only buffer containing the settings.
[in]sizeSize of the buffer.
Returns
SBG_NO_ERROR if the command has been executed successfully.

Definition at line 80 of file sbgEComCmdSettings.c.

◆ sbgEComCmdSettingsAction()

SbgErrorCode sbgEComCmdSettingsAction ( SbgEComHandle pHandle,
SbgEComSettingsAction  action 
)

Execute one of the available settings action :

  • SBG_ECOM_REBOOT_ONLY : Only reboot the device.
  • SBG_ECOM_SAVE_SETTINGS : Save the settings to non-volatile memory and then reboot the device.
  • SBG_ECOM_RESTORE_DEFAULT_SETTINGS : Restore default settings, save them to non-volatile memory and reboot the device.
    Parameters
    [in]pHandleA valid sbgECom handle.
    [in]actionOne of the available SbgEComSettingsAction.
    Returns
    SBG_NO_ERROR if the command has been executed successfully.

Definition at line 18 of file sbgEComCmdSettings.c.



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