Austin Blackstone / Mbed 2 deprecated client-lwip-lightswitch-demo-expanded

mbed client lightswitch demo

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Fork of mbed-client-classic-example-lwip by Austin Blackstone

mbed-client/mbed-client/m2mfirmware.h@11:cada08fc8a70, 2016-06-09 (annotated)

Committer:
mbedAustin
Date:
Thu Jun 09 17:08:36 2016 +0000
Revision:
11:cada08fc8a70
Commit for public Consumption

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbedAustin 11:cada08fc8a70 1 /*
mbedAustin 11:cada08fc8a70 2 * Copyright (c) 2015 ARM Limited. All rights reserved.
mbedAustin 11:cada08fc8a70 3 * SPDX-License-Identifier: Apache-2.0
mbedAustin 11:cada08fc8a70 4 * Licensed under the Apache License, Version 2.0 (the License); you may
mbedAustin 11:cada08fc8a70 5 * not use this file except in compliance with the License.
mbedAustin 11:cada08fc8a70 6 * You may obtain a copy of the License at
mbedAustin 11:cada08fc8a70 7 *
mbedAustin 11:cada08fc8a70 8 * http://www.apache.org/licenses/LICENSE-2.0
mbedAustin 11:cada08fc8a70 9 *
mbedAustin 11:cada08fc8a70 10 * Unless required by applicable law or agreed to in writing, software
mbedAustin 11:cada08fc8a70 11 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
mbedAustin 11:cada08fc8a70 12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mbedAustin 11:cada08fc8a70 13 * See the License for the specific language governing permissions and
mbedAustin 11:cada08fc8a70 14 * limitations under the License.
mbedAustin 11:cada08fc8a70 15 */
mbedAustin 11:cada08fc8a70 16 #ifndef M2MFIRMWARE_H
mbedAustin 11:cada08fc8a70 17 #define M2MFIRMWARE_H
mbedAustin 11:cada08fc8a70 18
mbedAustin 11:cada08fc8a70 19 #include "mbed-client/m2mobject.h"
mbedAustin 11:cada08fc8a70 20
mbedAustin 11:cada08fc8a70 21 // FORWARD DECLARATION
mbedAustin 11:cada08fc8a70 22 class M2MResource;
mbedAustin 11:cada08fc8a70 23 class M2MResourceInstance;
mbedAustin 11:cada08fc8a70 24
mbedAustin 11:cada08fc8a70 25 /**
mbedAustin 11:cada08fc8a70 26 * @brief M2MFirmware.
mbedAustin 11:cada08fc8a70 27 * This class represents the Firmware Object model of the LWM2M framework.
mbedAustin 11:cada08fc8a70 28 * It provides an interface for handling the firmware object
mbedAustin 11:cada08fc8a70 29 * and all its corresponding resources. There can be only one instance
mbedAustin 11:cada08fc8a70 30 * of a Firmware Object.
mbedAustin 11:cada08fc8a70 31 */
mbedAustin 11:cada08fc8a70 32 class M2MFirmware : public M2MObject {
mbedAustin 11:cada08fc8a70 33
mbedAustin 11:cada08fc8a70 34 friend class M2MInterfaceFactory;
mbedAustin 11:cada08fc8a70 35
mbedAustin 11:cada08fc8a70 36 public:
mbedAustin 11:cada08fc8a70 37
mbedAustin 11:cada08fc8a70 38 /**
mbedAustin 11:cada08fc8a70 39 * @brief Enum defining all the resources associated with a
mbedAustin 11:cada08fc8a70 40 * Firmware Object in the LWM2M framework.
mbedAustin 11:cada08fc8a70 41 */
mbedAustin 11:cada08fc8a70 42 typedef enum {
mbedAustin 11:cada08fc8a70 43 Package,
mbedAustin 11:cada08fc8a70 44 PackageUri,
mbedAustin 11:cada08fc8a70 45 Update,
mbedAustin 11:cada08fc8a70 46 State,
mbedAustin 11:cada08fc8a70 47 UpdateSupportedObjects,
mbedAustin 11:cada08fc8a70 48 UpdateResult,
mbedAustin 11:cada08fc8a70 49 PackageName,
mbedAustin 11:cada08fc8a70 50 PackageVersion
mbedAustin 11:cada08fc8a70 51 } FirmwareResource;
mbedAustin 11:cada08fc8a70 52
mbedAustin 11:cada08fc8a70 53 /**
mbedAustin 11:cada08fc8a70 54 * @brief Enum defining the state of the firmware update.
mbedAustin 11:cada08fc8a70 55 */
mbedAustin 11:cada08fc8a70 56 typedef enum {
mbedAustin 11:cada08fc8a70 57 Idle = 0,
mbedAustin 11:cada08fc8a70 58 Downloading,
mbedAustin 11:cada08fc8a70 59 Downloaded
mbedAustin 11:cada08fc8a70 60 } UpdateState;
mbedAustin 11:cada08fc8a70 61
mbedAustin 11:cada08fc8a70 62 /**
mbedAustin 11:cada08fc8a70 63 * @brief Enum defining the result of the firmware update.
mbedAustin 11:cada08fc8a70 64 */
mbedAustin 11:cada08fc8a70 65 typedef enum {
mbedAustin 11:cada08fc8a70 66 Default = 0,
mbedAustin 11:cada08fc8a70 67 SuccessfullyUpdated,
mbedAustin 11:cada08fc8a70 68 NotEnoughSpace,
mbedAustin 11:cada08fc8a70 69 OutOfMemory,
mbedAustin 11:cada08fc8a70 70 ConnectionLost,
mbedAustin 11:cada08fc8a70 71 CRCCheckFailure,
mbedAustin 11:cada08fc8a70 72 UnsupportedPackageType,
mbedAustin 11:cada08fc8a70 73 InvalidURI
mbedAustin 11:cada08fc8a70 74 } ResultOfUpdate;
mbedAustin 11:cada08fc8a70 75
mbedAustin 11:cada08fc8a70 76 private:
mbedAustin 11:cada08fc8a70 77
mbedAustin 11:cada08fc8a70 78 /**
mbedAustin 11:cada08fc8a70 79 * Constructor
mbedAustin 11:cada08fc8a70 80 */
mbedAustin 11:cada08fc8a70 81 M2MFirmware();
mbedAustin 11:cada08fc8a70 82
mbedAustin 11:cada08fc8a70 83 // Prevents the use of assignment operator.
mbedAustin 11:cada08fc8a70 84 M2MFirmware& operator=( const M2MFirmware& /*other*/ );
mbedAustin 11:cada08fc8a70 85
mbedAustin 11:cada08fc8a70 86 // Prevents the use of copy constructor.
mbedAustin 11:cada08fc8a70 87 M2MFirmware( const M2MFirmware& /*other*/ );
mbedAustin 11:cada08fc8a70 88
mbedAustin 11:cada08fc8a70 89 /**
mbedAustin 11:cada08fc8a70 90 * Destructor
mbedAustin 11:cada08fc8a70 91 */
mbedAustin 11:cada08fc8a70 92 virtual ~M2MFirmware();
mbedAustin 11:cada08fc8a70 93
mbedAustin 11:cada08fc8a70 94 static M2MFirmware* get_instance();
mbedAustin 11:cada08fc8a70 95
mbedAustin 11:cada08fc8a70 96 public:
mbedAustin 11:cada08fc8a70 97
mbedAustin 11:cada08fc8a70 98 /**
mbedAustin 11:cada08fc8a70 99 * @brief Deletes the M2MFirmware instance.
mbedAustin 11:cada08fc8a70 100 */
mbedAustin 11:cada08fc8a70 101 static void delete_instance();
mbedAustin 11:cada08fc8a70 102
mbedAustin 11:cada08fc8a70 103 /**
mbedAustin 11:cada08fc8a70 104 * @brief Creates a new resource for given resource enum.
mbedAustin 11:cada08fc8a70 105 * @param resource, With this function, the following resources can be created:
mbedAustin 11:cada08fc8a70 106 * 'PackageUri', 'PackageName','PackageVersion'.
mbedAustin 11:cada08fc8a70 107 * @param value, Value to be set on the resource, in String format.
mbedAustin 11:cada08fc8a70 108 * @return M2MResource if created successfully, else NULL.
mbedAustin 11:cada08fc8a70 109 */
mbedAustin 11:cada08fc8a70 110 M2MResource* create_resource(FirmwareResource resource, const String &value);
mbedAustin 11:cada08fc8a70 111
mbedAustin 11:cada08fc8a70 112 /**
mbedAustin 11:cada08fc8a70 113 * @brief Creates a new resource for given resource enum.
mbedAustin 11:cada08fc8a70 114 * @param resource, With this function, the following resources can be created:
mbedAustin 11:cada08fc8a70 115 * 'State','UpdateSupportedObjects','UpdateResult'.
mbedAustin 11:cada08fc8a70 116 * @param value, Value to be set on the resource, in Integer format.
mbedAustin 11:cada08fc8a70 117 * @return M2MResource if created successfully, else NULL.
mbedAustin 11:cada08fc8a70 118 */
mbedAustin 11:cada08fc8a70 119 M2MResource* create_resource(FirmwareResource resource, int64_t value);
mbedAustin 11:cada08fc8a70 120
mbedAustin 11:cada08fc8a70 121 /**
mbedAustin 11:cada08fc8a70 122 * @brief Deletes the resource with the given resource enum.
mbedAustin 11:cada08fc8a70 123 * Mandatory resources cannot be deleted.
mbedAustin 11:cada08fc8a70 124 * @param resource, Name of the resource to be deleted.
mbedAustin 11:cada08fc8a70 125 * @return True if deleted, else false.
mbedAustin 11:cada08fc8a70 126 */
mbedAustin 11:cada08fc8a70 127 bool delete_resource(FirmwareResource resource);
mbedAustin 11:cada08fc8a70 128
mbedAustin 11:cada08fc8a70 129 /**
mbedAustin 11:cada08fc8a70 130 * @brief Sets the value of the given resource enum.
mbedAustin 11:cada08fc8a70 131 * @param resource, With this function, a value can be set on the following resources:
mbedAustin 11:cada08fc8a70 132 * 'Package', 'PackageUri', 'PackageName','PackageVersion'.
mbedAustin 11:cada08fc8a70 133 * @param value, Value to be set on the resource, in String format.
mbedAustin 11:cada08fc8a70 134 * @return True if successfully set, else false.
mbedAustin 11:cada08fc8a70 135 */
mbedAustin 11:cada08fc8a70 136 bool set_resource_value(FirmwareResource resource,
mbedAustin 11:cada08fc8a70 137 const String &value);
mbedAustin 11:cada08fc8a70 138
mbedAustin 11:cada08fc8a70 139 /**
mbedAustin 11:cada08fc8a70 140 * @brief Sets the value of the given resource enum.
mbedAustin 11:cada08fc8a70 141 * @param resource, With this function, a value can be set for the following resources:
mbedAustin 11:cada08fc8a70 142 * 'State','UpdateSupportedObjects','UpdateResult'.
mbedAustin 11:cada08fc8a70 143 * @param value, Value to be set on the resource, in Integer format.
mbedAustin 11:cada08fc8a70 144 * @return True if successfully set, else false.
mbedAustin 11:cada08fc8a70 145 */
mbedAustin 11:cada08fc8a70 146 bool set_resource_value(FirmwareResource resource,
mbedAustin 11:cada08fc8a70 147 int64_t value);
mbedAustin 11:cada08fc8a70 148
mbedAustin 11:cada08fc8a70 149 /**
mbedAustin 11:cada08fc8a70 150 * @brief Sets the value of the given resource enum.
mbedAustin 11:cada08fc8a70 151 * @param resource, With this function, a value can be set for the following resources:
mbedAustin 11:cada08fc8a70 152 * 'Package'.
mbedAustin 11:cada08fc8a70 153 * @param value, Value to be set on the resource, in uint8_t format.
mbedAustin 11:cada08fc8a70 154 * @param size, Size of the buffer value to be set on the resource.
mbedAustin 11:cada08fc8a70 155 * @return True if successfully set, else false.
mbedAustin 11:cada08fc8a70 156 */
mbedAustin 11:cada08fc8a70 157 bool set_resource_value(FirmwareResource resource,
mbedAustin 11:cada08fc8a70 158 const uint8_t *value,
mbedAustin 11:cada08fc8a70 159 const uint32_t length);
mbedAustin 11:cada08fc8a70 160
mbedAustin 11:cada08fc8a70 161 /**
mbedAustin 11:cada08fc8a70 162 * @brief Returns the value of the given resource enum, in String.
mbedAustin 11:cada08fc8a70 163 * @param resource, With this function, the following resources can return value:
mbedAustin 11:cada08fc8a70 164 * 'PackageUri', 'PackageName','PackageVersion'.
mbedAustin 11:cada08fc8a70 165 * @return Value associated with that resource, if key is not valid it returns NULL.
mbedAustin 11:cada08fc8a70 166 */
mbedAustin 11:cada08fc8a70 167 String resource_value_string(FirmwareResource resource) const;
mbedAustin 11:cada08fc8a70 168
mbedAustin 11:cada08fc8a70 169 /**
mbedAustin 11:cada08fc8a70 170 * @brief Returns the value of the given resource key name, in Integer.
mbedAustin 11:cada08fc8a70 171 * @param resource, With this function, the following resources can return a value:
mbedAustin 11:cada08fc8a70 172 * 'State','UpdateSupportedObjects','UpdateResult'.
mbedAustin 11:cada08fc8a70 173 * @return Value associated with that resource. If the resource is not valid -1 is returned.
mbedAustin 11:cada08fc8a70 174 */
mbedAustin 11:cada08fc8a70 175 int64_t resource_value_int(FirmwareResource resource) const;
mbedAustin 11:cada08fc8a70 176
mbedAustin 11:cada08fc8a70 177 /**
mbedAustin 11:cada08fc8a70 178 * @brief Populates the data buffer and returns the size of the buffer.
mbedAustin 11:cada08fc8a70 179 * @param resource, With this function, the following resources can return a value:
mbedAustin 11:cada08fc8a70 180 * 'Package'.
mbedAustin 11:cada08fc8a70 181 * @param [OUT] data, Data buffer containing the value.
mbedAustin 11:cada08fc8a70 182 * @return Size of the buffer populated.
mbedAustin 11:cada08fc8a70 183 */
mbedAustin 11:cada08fc8a70 184 uint32_t resource_value_buffer(FirmwareResource resource,
mbedAustin 11:cada08fc8a70 185 uint8_t *&data) const;
mbedAustin 11:cada08fc8a70 186
mbedAustin 11:cada08fc8a70 187 /**
mbedAustin 11:cada08fc8a70 188 * @brief Returns whether the resource instance with given resource enum exists or not.
mbedAustin 11:cada08fc8a70 189 * @param resource, Resource enum.
mbedAustin 11:cada08fc8a70 190 * @return True if at least one instance exists, else false.
mbedAustin 11:cada08fc8a70 191 */
mbedAustin 11:cada08fc8a70 192 bool is_resource_present(FirmwareResource resource) const;
mbedAustin 11:cada08fc8a70 193
mbedAustin 11:cada08fc8a70 194 /**
mbedAustin 11:cada08fc8a70 195 * @brief Returns number of resources for the whole firmware object.
mbedAustin 11:cada08fc8a70 196 * @return Total number of resources belonging to the firmware object.
mbedAustin 11:cada08fc8a70 197 */
mbedAustin 11:cada08fc8a70 198 uint16_t total_resource_count() const;
mbedAustin 11:cada08fc8a70 199
mbedAustin 11:cada08fc8a70 200 /**
mbedAustin 11:cada08fc8a70 201 * @brief Returns the number of resources for a given resource enum.
mbedAustin 11:cada08fc8a70 202 * @param resource, Resource enum.
mbedAustin 11:cada08fc8a70 203 * @return Number of resources for a given resource enum. Returns 1 for the
mbedAustin 11:cada08fc8a70 204 * mandatory resources. Can be 0 as well if no instance exists for an
mbedAustin 11:cada08fc8a70 205 * optional resource.
mbedAustin 11:cada08fc8a70 206 */
mbedAustin 11:cada08fc8a70 207 uint16_t per_resource_count(FirmwareResource resource) const;
mbedAustin 11:cada08fc8a70 208
mbedAustin 11:cada08fc8a70 209
mbedAustin 11:cada08fc8a70 210 private:
mbedAustin 11:cada08fc8a70 211
mbedAustin 11:cada08fc8a70 212 M2MResource* get_resource(FirmwareResource resource) const;
mbedAustin 11:cada08fc8a70 213
mbedAustin 11:cada08fc8a70 214 String resource_name(FirmwareResource resource) const;
mbedAustin 11:cada08fc8a70 215
mbedAustin 11:cada08fc8a70 216 void create_mandatory_resources();
mbedAustin 11:cada08fc8a70 217
mbedAustin 11:cada08fc8a70 218 bool check_value_range(FirmwareResource resource, const int64_t value) const;
mbedAustin 11:cada08fc8a70 219
mbedAustin 11:cada08fc8a70 220 private :
mbedAustin 11:cada08fc8a70 221
mbedAustin 11:cada08fc8a70 222 M2MObjectInstance* _firmware_instance; //Not owned
mbedAustin 11:cada08fc8a70 223
mbedAustin 11:cada08fc8a70 224 protected:
mbedAustin 11:cada08fc8a70 225
mbedAustin 11:cada08fc8a70 226 static M2MFirmware* _instance;
mbedAustin 11:cada08fc8a70 227
mbedAustin 11:cada08fc8a70 228 friend class Test_M2MFirmware;
mbedAustin 11:cada08fc8a70 229 friend class Test_M2MInterfaceFactory;
mbedAustin 11:cada08fc8a70 230 };
mbedAustin 11:cada08fc8a70 231
mbedAustin 11:cada08fc8a70 232
mbedAustin 11:cada08fc8a70 233 #endif // M2MFIRMWARE_H