HAN-FUN API  1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
suota.h File Reference

This file contains the definitions for the SUOTA interface. More...

#include "hanfun/common.h"
#include "hanfun/protocol.h"
#include "hanfun/core.h"
+ Include dependency graph for suota.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  HF::Core::SUOTA::Version
 Helper class that represents the information of a particular version. More...
 
struct  HF::Core::SUOTA::CheckVersionResponse
 This class represents the message for the response of a SUOTA::CHECK_VERSION_CMD. More...
 
struct  HF::Core::SUOTA::UpgradeStatus
 This class contains the required parameters for a SUOTA::UPGRADE_COMPLETE_CMD command. More...
 
struct  HF::Core::SUOTA::Base
 SUOTA Interfaces::Interface : Parent. More...
 
class  HF::Core::SUOTA::Server
 SUOTA Interfaces::Interface : Server side implementation. More...
 
struct  HF::Core::SUOTA::Client
 SUOTA Interfaces::Interface : Client side implementation. More...
 

Namespaces

 HF
 Top-level namespace for the HAN-FUN library.
 
 HF::Core
 This is the top-level namespace for the Core Services and Interfaces implementation.
 
 HF::Core::SUOTA
 This namespace contains the implementation of the SUOTA interface.
 

Enumerations

enum  HF::Core::SUOTA::CMD { HF::Core::SUOTA::NEW_VERSION_AVAILABLE_CMD = 1, HF::Core::SUOTA::CHECK_VERSION_CMD = 1, HF::Core::SUOTA::UPGRADE_COMPLETE_CMD = 2 }
 Command IDs. More...
 
enum  HF::Core::SUOTA::NewVersionResponse {
  HF::Core::SUOTA::UPGRADE_INITIATED = 0x00, HF::Core::SUOTA::INVALID_SOFTWARE = 0x11, HF::Core::SUOTA::UNSUPPORTED_HARDWARE = 0x12, HF::Core::SUOTA::BATTERY_TOO_LOW = 0x13,
  HF::Core::SUOTA::FAIL_UNKNOWN = Common::FAIL_UNKNOWN
}
 Result codes for a SUOTA::NEW_VERSION_AVAILABLE_CMD. More...
 

Functions

HF::Attributes::IAttributeHF::Core::create_attribute (SUOTA::Server *server, uint8_t uid)
 Create an attribute object that can hold the attribute with the given uid. More...
 
HF::Attributes::IAttributeHF::Core::SUOTA::create_attribute (uint8_t uid)
 Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SUOTA::Server *,uint8_t) More...
 
std::ostream & operator<< (std::ostream &stream, const HF::Core::SUOTA::CMD command)
 Convert the given command into a string and write it to the given stream. More...
 

Detailed Description

This file contains the definitions for the SUOTA interface.

Version
1.5.3

For licensing information, please see the file 'LICENSE' in the root folder.

Initial development by Bithium S.A. [http://www.bithium.com]

Definition in file suota.h.