sbgEComCmdSettings.h File Reference

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

#include "sbgEComCmdCommon.h"

Include dependency graph for sbgEComCmdSettings.h:

This graph shows which files directly or indirectly include this file:

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	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)

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.

Definition in file sbgEComCmdSettings.h.

Typedef Documentation

typedef enum _SbgEComSettingsAction SbgEComSettingsAction

Defintion of all the settings actions available.

Enumeration Type Documentation

enum _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.

Definition at line 32 of file sbgEComCmdSettings.h.

Function Documentation

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]	pHandle	A valid sbgECom handle.
[in]	pBuffer	Allocated buffer that can hold the received settings.
[out]	pSize	The number of bytes that have been stored into pBuffer.
[in]	maxSize	The 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 107 of file sbgEComCmdSettings.c.

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]	pHandle	A valid sbgECom handle.
[in]	pBuffer	Read only buffer containing the settings.
[in]	size	Size of the buffer.

Returns

SBG_NO_ERROR if the command has been executed successfully.

Definition at line 91 of file sbgEComCmdSettings.c.

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]	pHandle	A valid sbgECom handle.
  [in]	action	One of the available SbgEComSettingsAction.

  Returns

  SBG_NO_ERROR if the command has been executed successfully.

Definition at line 18 of file sbgEComCmdSettings.c.