sbgECom  1.11.920-stable
Typedefs | Enumerations | Functions
sbgEComCmdSettings.h File Reference

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

#include "sbgEComCmdCommon.h"

Go to the source code of this file.

Typedefs

typedef enum _SbgEComSettingsAction SbgEComSettingsAction
 

Enumerations

enum  _SbgEComSettingsAction {
  SBG_ECOM_REBOOT_ONLY = 0,
  SBG_ECOM_SAVE_SETTINGS = 1,
  SBG_ECOM_RESTORE_DEFAULT_SETTINGS = 2
}
 

Functions

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

Detailed Description

This file implements SbgECom commands related to settings.

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

§ SbgEComSettingsAction

Defintion of all the settings actions available.

Enumeration Type Documentation

§ _SbgEComSettingsAction

Defintion of all the settings actions available.

Enumerator
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.

Function Documentation

§ 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.

§ 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.

§ 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.