Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
wakaama/liblwm2m.h@16:31c387e94b6d, 2017-05-11 (annotated)
- Committer:
- terencez
- Date:
- Thu May 11 12:40:25 2017 +0000
- Revision:
- 16:31c387e94b6d
- Parent:
- 14:ec9e195830ff
Added a demo temperature object based on sensor LM75B.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
terencez | 0:f9d13e09cf11 | 1 | /******************************************************************************* |
terencez | 0:f9d13e09cf11 | 2 | * |
terencez | 0:f9d13e09cf11 | 3 | * Copyright (c) 2013, 2014 Intel Corporation and others. |
terencez | 0:f9d13e09cf11 | 4 | * All rights reserved. This program and the accompanying materials |
terencez | 0:f9d13e09cf11 | 5 | * are made available under the terms of the Eclipse Public License v1.0 |
terencez | 0:f9d13e09cf11 | 6 | * and Eclipse Distribution License v1.0 which accompany this distribution. |
terencez | 0:f9d13e09cf11 | 7 | * |
terencez | 0:f9d13e09cf11 | 8 | * The Eclipse Public License is available at |
terencez | 0:f9d13e09cf11 | 9 | * http://www.eclipse.org/legal/epl-v10.html |
terencez | 0:f9d13e09cf11 | 10 | * The Eclipse Distribution License is available at |
terencez | 0:f9d13e09cf11 | 11 | * http://www.eclipse.org/org/documents/edl-v10.php. |
terencez | 0:f9d13e09cf11 | 12 | * |
terencez | 0:f9d13e09cf11 | 13 | * Contributors: |
terencez | 0:f9d13e09cf11 | 14 | * David Navarro, Intel Corporation - initial API and implementation |
terencez | 0:f9d13e09cf11 | 15 | * Fabien Fleutot - Please refer to git log |
terencez | 0:f9d13e09cf11 | 16 | * Simon Bernard - Please refer to git log |
terencez | 0:f9d13e09cf11 | 17 | * Toby Jaffey - Please refer to git log |
terencez | 0:f9d13e09cf11 | 18 | * Julien Vermillard - Please refer to git log |
terence zhang | 3:a280069151ac | 19 | * Bosch Software Innovations GmbH - Please refer to git log |
terence zhang | 3:a280069151ac | 20 | * Pascal Rieux - Please refer to git log |
terencez | 0:f9d13e09cf11 | 21 | *******************************************************************************/ |
terencez | 0:f9d13e09cf11 | 22 | |
terencez | 0:f9d13e09cf11 | 23 | /* |
terencez | 0:f9d13e09cf11 | 24 | Copyright (c) 2013, 2014 Intel Corporation |
terencez | 0:f9d13e09cf11 | 25 | |
terencez | 0:f9d13e09cf11 | 26 | Redistribution and use in source and binary forms, with or without modification, |
terencez | 0:f9d13e09cf11 | 27 | are permitted provided that the following conditions are met: |
terencez | 0:f9d13e09cf11 | 28 | |
terencez | 0:f9d13e09cf11 | 29 | * Redistributions of source code must retain the above copyright notice, |
terencez | 0:f9d13e09cf11 | 30 | this list of conditions and the following disclaimer. |
terencez | 0:f9d13e09cf11 | 31 | * Redistributions in binary form must reproduce the above copyright notice, |
terencez | 0:f9d13e09cf11 | 32 | this list of conditions and the following disclaimer in the documentation |
terencez | 0:f9d13e09cf11 | 33 | and/or other materials provided with the distribution. |
terencez | 0:f9d13e09cf11 | 34 | * Neither the name of Intel Corporation nor the names of its contributors |
terencez | 0:f9d13e09cf11 | 35 | may be used to endorse or promote products derived from this software |
terencez | 0:f9d13e09cf11 | 36 | without specific prior written permission. |
terencez | 0:f9d13e09cf11 | 37 | |
terencez | 0:f9d13e09cf11 | 38 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
terencez | 0:f9d13e09cf11 | 39 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
terencez | 0:f9d13e09cf11 | 40 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
terencez | 0:f9d13e09cf11 | 41 | IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, |
terencez | 0:f9d13e09cf11 | 42 | INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
terencez | 0:f9d13e09cf11 | 43 | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
terencez | 0:f9d13e09cf11 | 44 | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
terencez | 0:f9d13e09cf11 | 45 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
terencez | 0:f9d13e09cf11 | 46 | OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF |
terencez | 0:f9d13e09cf11 | 47 | THE POSSIBILITY OF SUCH DAMAGE. |
terencez | 0:f9d13e09cf11 | 48 | |
terencez | 0:f9d13e09cf11 | 49 | David Navarro <david.navarro@intel.com> |
terencez | 0:f9d13e09cf11 | 50 | |
terencez | 0:f9d13e09cf11 | 51 | */ |
terencez | 0:f9d13e09cf11 | 52 | |
terencez | 0:f9d13e09cf11 | 53 | #ifndef _LWM2M_CLIENT_H_ |
terencez | 0:f9d13e09cf11 | 54 | #define _LWM2M_CLIENT_H_ |
terencez | 0:f9d13e09cf11 | 55 | |
terence zhang | 3:a280069151ac | 56 | #ifdef __cplusplus |
terence zhang | 3:a280069151ac | 57 | extern "C" { |
terence zhang | 3:a280069151ac | 58 | #endif |
terence zhang | 3:a280069151ac | 59 | |
terencez | 0:f9d13e09cf11 | 60 | #include <stdint.h> |
terencez | 0:f9d13e09cf11 | 61 | #include <stddef.h> |
terencez | 0:f9d13e09cf11 | 62 | #include <stdbool.h> |
terence zhang | 3:a280069151ac | 63 | #include <time.h> |
terence zhang | 3:a280069151ac | 64 | |
terencez | 0:f9d13e09cf11 | 65 | |
terencez | 11:1fadb70654a6 | 66 | #define MBED_OS_EXAMPLE_WAKAAMA |
terencez | 11:1fadb70654a6 | 67 | |
terencez | 10:df97539c6ddd | 68 | #ifdef MBED_OS_EXAMPLE_WAKAAMA |
terencez | 0:f9d13e09cf11 | 69 | #include <stdlib.h> |
terencez | 0:f9d13e09cf11 | 70 | #include <string.h> |
terencez | 13:4e6f1ebf886c | 71 | #include "er-coap-13/er-coap-13.h" |
terencez | 11:1fadb70654a6 | 72 | #endif |
terencez | 11:1fadb70654a6 | 73 | |
terencez | 11:1fadb70654a6 | 74 | ////////////////////////////////////////////////// |
terencez | 11:1fadb70654a6 | 75 | #ifdef MBED_OS_EXAMPLE_WAKAAMA |
terencez | 0:f9d13e09cf11 | 76 | // Global definitions |
terencez | 0:f9d13e09cf11 | 77 | #define LWM2M_LITTLE_ENDIAN |
terencez | 0:f9d13e09cf11 | 78 | #define LWM2M_CLIENT_MODE |
terencez | 0:f9d13e09cf11 | 79 | #define LWM2M_WITH_LOGS |
terencez | 0:f9d13e09cf11 | 80 | #define SHARED_DEFINITIONS |
terencez | 0:f9d13e09cf11 | 81 | #define WAKAAMA_DEFINITIONS |
terencez | 16:31c387e94b6d | 82 | |
terencez | 16:31c387e94b6d | 83 | //#define ENABLE_RGB_LED, WIP |
terencez | 0:f9d13e09cf11 | 84 | #endif |
terencez | 0:f9d13e09cf11 | 85 | |
terencez | 0:f9d13e09cf11 | 86 | #ifndef LWM2M_EMBEDDED_MODE |
terencez | 0:f9d13e09cf11 | 87 | /** LWIP_TIMEVAL_PRIVATE: if you want to use the struct timeval provided |
terencez | 0:f9d13e09cf11 | 88 | * by your system, set this to 0 and include <sys/time.h> in cc.h */ |
terencez | 14:ec9e195830ff | 89 | //typedef long time_t |
terencez | 0:f9d13e09cf11 | 90 | |
terencez | 0:f9d13e09cf11 | 91 | struct timeval { |
terencez | 14:ec9e195830ff | 92 | time_t tv_sec; /* seconds */ |
terencez | 14:ec9e195830ff | 93 | time_t tv_usec; /* and microseconds */ |
terencez | 0:f9d13e09cf11 | 94 | }; |
terencez | 0:f9d13e09cf11 | 95 | struct timezone{ |
terencez | 0:f9d13e09cf11 | 96 | |
terencez | 0:f9d13e09cf11 | 97 | int tz_minuteswest; /*minutes to greenwich time*/ |
terencez | 0:f9d13e09cf11 | 98 | int tz_dsttime; /*type of DST correction*/ |
terencez | 0:f9d13e09cf11 | 99 | }; |
terencez | 0:f9d13e09cf11 | 100 | |
terencez | 0:f9d13e09cf11 | 101 | #endif |
terencez | 0:f9d13e09cf11 | 102 | |
terence zhang | 3:a280069151ac | 103 | |
terence zhang | 3:a280069151ac | 104 | #ifdef LWM2M_SERVER_MODE |
terence zhang | 3:a280069151ac | 105 | #ifndef LWM2M_SUPPORT_JSON |
terence zhang | 3:a280069151ac | 106 | #define LWM2M_SUPPORT_JSON |
terence zhang | 3:a280069151ac | 107 | #endif |
terence zhang | 3:a280069151ac | 108 | #endif |
terence zhang | 3:a280069151ac | 109 | |
terence zhang | 3:a280069151ac | 110 | #if defined(LWM2M_BOOTSTRAP) && defined(LWM2M_BOOTSTRAP_SERVER_MODE) |
terence zhang | 3:a280069151ac | 111 | #error "LWM2M_BOOTSTRAP and LWM2M_BOOTSTRAP_SERVER_MODE cannot be defined at the same time!" |
terence zhang | 3:a280069151ac | 112 | #endif |
terence zhang | 3:a280069151ac | 113 | |
terence zhang | 3:a280069151ac | 114 | /* |
terence zhang | 3:a280069151ac | 115 | * Platform abstraction functions to be implemented by the user |
terence zhang | 3:a280069151ac | 116 | */ |
terence zhang | 3:a280069151ac | 117 | |
terence zhang | 3:a280069151ac | 118 | #ifndef LWM2M_MEMORY_TRACE |
terence zhang | 3:a280069151ac | 119 | // Allocate a block of size bytes of memory, returning a pointer to the beginning of the block. |
terence zhang | 3:a280069151ac | 120 | void * lwm2m_malloc(size_t s); |
terence zhang | 3:a280069151ac | 121 | // Deallocate a block of memory previously allocated by lwm2m_malloc() or lwm2m_strdup() |
terence zhang | 3:a280069151ac | 122 | void lwm2m_free(void * p); |
terence zhang | 3:a280069151ac | 123 | // Allocate a memory block, duplicate the string str in it and return a pointer to this new block. |
terence zhang | 3:a280069151ac | 124 | char * lwm2m_strdup(const char * str); |
terence zhang | 3:a280069151ac | 125 | #else |
terence zhang | 3:a280069151ac | 126 | // same functions as above with caller location for debugging purposes |
terence zhang | 3:a280069151ac | 127 | char * lwm2m_trace_strdup(const char * str, const char * file, const char * function, int lineno); |
terence zhang | 3:a280069151ac | 128 | void * lwm2m_trace_malloc(size_t size, const char * file, const char * function, int lineno); |
terence zhang | 3:a280069151ac | 129 | void lwm2m_trace_free(void * mem, const char * file, const char * function, int lineno); |
terence zhang | 3:a280069151ac | 130 | |
terence zhang | 3:a280069151ac | 131 | #define lwm2m_strdup(S) lwm2m_trace_strdup(S, __FILE__, __FUNCTION__, __LINE__) |
terence zhang | 3:a280069151ac | 132 | #define lwm2m_malloc(S) lwm2m_trace_malloc(S, __FILE__, __FUNCTION__, __LINE__) |
terence zhang | 3:a280069151ac | 133 | #define lwm2m_free(M) lwm2m_trace_free(M, __FILE__, __FUNCTION__, __LINE__) |
terence zhang | 3:a280069151ac | 134 | #endif |
terence zhang | 3:a280069151ac | 135 | // Compare at most the n first bytes of s1 and s2, return 0 if they match |
terence zhang | 3:a280069151ac | 136 | int lwm2m_strncmp(const char * s1, const char * s2, size_t n); |
terence zhang | 3:a280069151ac | 137 | // This function must return the number of seconds elapsed since origin. |
terence zhang | 3:a280069151ac | 138 | // The origin (Epoch, system boot, etc...) does not matter as this |
terence zhang | 3:a280069151ac | 139 | // function is used only to determine the elapsed time since the last |
terence zhang | 3:a280069151ac | 140 | // call to it. |
terence zhang | 3:a280069151ac | 141 | // In case of error, this must return a negative value. |
terence zhang | 3:a280069151ac | 142 | // Per POSIX specifications, time_t is a signed integer. |
terence zhang | 3:a280069151ac | 143 | time_t lwm2m_gettime(void); |
terence zhang | 3:a280069151ac | 144 | |
terence zhang | 3:a280069151ac | 145 | #ifdef LWM2M_WITH_LOGS |
terence zhang | 3:a280069151ac | 146 | // Same usage as C89 printf() |
terence zhang | 3:a280069151ac | 147 | void lwm2m_printf(const char * format, ...); |
terence zhang | 3:a280069151ac | 148 | #endif |
terence zhang | 3:a280069151ac | 149 | |
terence zhang | 3:a280069151ac | 150 | // communication layer |
terence zhang | 3:a280069151ac | 151 | #ifdef LWM2M_CLIENT_MODE |
terencez | 14:ec9e195830ff | 152 | |
terence zhang | 3:a280069151ac | 153 | // Returns a session handle that MUST uniquely identify a peer. |
terence zhang | 3:a280069151ac | 154 | // secObjInstID: ID of the Securty Object instance to open a connection to |
terence zhang | 3:a280069151ac | 155 | // userData: parameter to lwm2m_init() |
terence zhang | 3:a280069151ac | 156 | void * lwm2m_connect_server(uint16_t secObjInstID, void * userData); |
terence zhang | 3:a280069151ac | 157 | // Close a session created by lwm2m_connect_server() |
terence zhang | 3:a280069151ac | 158 | // sessionH: session handle identifying the peer (opaque to the core) |
terence zhang | 3:a280069151ac | 159 | // userData: parameter to lwm2m_init() |
terence zhang | 3:a280069151ac | 160 | void lwm2m_close_connection(void * sessionH, void * userData); |
terence zhang | 3:a280069151ac | 161 | #endif |
terence zhang | 3:a280069151ac | 162 | // Send data to a peer |
terence zhang | 3:a280069151ac | 163 | // Returns COAP_NO_ERROR or a COAP_NNN error code |
terence zhang | 3:a280069151ac | 164 | // sessionH: session handle identifying the peer (opaque to the core) |
terence zhang | 3:a280069151ac | 165 | // buffer, length: data to send |
terence zhang | 3:a280069151ac | 166 | // userData: parameter to lwm2m_init() |
terencez | 14:ec9e195830ff | 167 | coap_status_t lwm2m_buffer_send(void * sessionH, uint8_t * buffer, size_t length, void * userData); |
terence zhang | 3:a280069151ac | 168 | // Compare two session handles |
terence zhang | 3:a280069151ac | 169 | // Returns true if the two sessions identify the same peer. false otherwise. |
terence zhang | 3:a280069151ac | 170 | // userData: parameter to lwm2m_init() |
terence zhang | 3:a280069151ac | 171 | bool lwm2m_session_is_equal(void * session1, void * session2, void * userData); |
terence zhang | 3:a280069151ac | 172 | |
terencez | 0:f9d13e09cf11 | 173 | /* |
terencez | 0:f9d13e09cf11 | 174 | * Error code |
terencez | 0:f9d13e09cf11 | 175 | */ |
terencez | 0:f9d13e09cf11 | 176 | |
terencez | 11:1fadb70654a6 | 177 | #ifdef MBED_OS_EXAMPLE_WAKAAMA |
terencez | 11:1fadb70654a6 | 178 | //Prefer to use the orignal enum from the coap stack, remove warnings. |
terencez | 11:1fadb70654a6 | 179 | #define COAP_NO_ERROR NO_ERROR//(uint8_t)0x00 |
terencez | 11:1fadb70654a6 | 180 | #define COAP_IGNORE (uint8_t)0x01 |
terencez | 11:1fadb70654a6 | 181 | |
terencez | 11:1fadb70654a6 | 182 | #define COAP_201_CREATED CREATED_2_01//(uint8_t)0x41 |
terencez | 11:1fadb70654a6 | 183 | #define COAP_202_DELETED DELETED_2_02//(uint8_t)0x42 |
terencez | 11:1fadb70654a6 | 184 | |
terencez | 11:1fadb70654a6 | 185 | #define COAP_204_CHANGED CHANGED_2_04//(uint8_t)0x44 |
terencez | 11:1fadb70654a6 | 186 | #define COAP_205_CONTENT CONTENT_2_05//(uint8_t)0x45 |
terencez | 11:1fadb70654a6 | 187 | #define COAP_231_CONTINUE (uint8_t)0x5F |
terencez | 11:1fadb70654a6 | 188 | |
terencez | 11:1fadb70654a6 | 189 | #define COAP_400_BAD_REQUEST BAD_REQUEST_4_00//(uint8_t)0x80 |
terencez | 11:1fadb70654a6 | 190 | #define COAP_401_UNAUTHORIZED UNAUTHORIZED_4_01//(uint8_t)0x81 |
terencez | 11:1fadb70654a6 | 191 | #define COAP_402_BAD_OPTION BAD_OPTION_4_02//(uint8_t)0x82 |
terencez | 11:1fadb70654a6 | 192 | #define COAP_404_NOT_FOUND NOT_FOUND_4_04//(uint8_t)0x84 |
terencez | 11:1fadb70654a6 | 193 | #define COAP_405_METHOD_NOT_ALLOWED METHOD_NOT_ALLOWED_4_05//(uint8_t)0x85 |
terencez | 11:1fadb70654a6 | 194 | #define COAP_406_NOT_ACCEPTABLE NOT_ACCEPTABLE_4_06//(uint8_t)0x86 |
terencez | 11:1fadb70654a6 | 195 | #define COAP_408_REQ_ENTITY_INCOMPLETE (uint8_t)0x88 |
terencez | 11:1fadb70654a6 | 196 | #define COAP_412_PRECONDITION_FAILED PRECONDITION_FAILED_4_12//(uint8_t)0x8C |
terencez | 11:1fadb70654a6 | 197 | #define COAP_413_ENTITY_TOO_LARGE REQUEST_ENTITY_TOO_LARGE_4_13//(uint8_t)0x8D |
terencez | 11:1fadb70654a6 | 198 | #define COAP_500_INTERNAL_SERVER_ERROR INTERNAL_SERVER_ERROR_5_00//(uint8_t)0xA0 |
terencez | 11:1fadb70654a6 | 199 | #define COAP_501_NOT_IMPLEMENTED NOT_IMPLEMENTED_5_01//(uint8_t)0xA1 |
terencez | 11:1fadb70654a6 | 200 | #define COAP_503_SERVICE_UNAVAILABLE SERVICE_UNAVAILABLE_5_03//(uint8_t)0xA3 |
terencez | 11:1fadb70654a6 | 201 | #else |
terencez | 0:f9d13e09cf11 | 202 | #define COAP_NO_ERROR (uint8_t)0x00 |
terence zhang | 3:a280069151ac | 203 | #define COAP_IGNORE (uint8_t)0x01 |
terencez | 0:f9d13e09cf11 | 204 | |
terencez | 0:f9d13e09cf11 | 205 | #define COAP_201_CREATED (uint8_t)0x41 |
terencez | 0:f9d13e09cf11 | 206 | #define COAP_202_DELETED (uint8_t)0x42 |
terencez | 11:1fadb70654a6 | 207 | |
terencez | 0:f9d13e09cf11 | 208 | #define COAP_204_CHANGED (uint8_t)0x44 |
terencez | 0:f9d13e09cf11 | 209 | #define COAP_205_CONTENT (uint8_t)0x45 |
terencez | 11:1fadb70654a6 | 210 | |
terence zhang | 3:a280069151ac | 211 | #define COAP_231_CONTINUE (uint8_t)0x5F |
terencez | 0:f9d13e09cf11 | 212 | #define COAP_400_BAD_REQUEST (uint8_t)0x80 |
terencez | 0:f9d13e09cf11 | 213 | #define COAP_401_UNAUTHORIZED (uint8_t)0x81 |
terence zhang | 3:a280069151ac | 214 | #define COAP_402_BAD_OPTION (uint8_t)0x82 |
terencez | 0:f9d13e09cf11 | 215 | #define COAP_404_NOT_FOUND (uint8_t)0x84 |
terencez | 0:f9d13e09cf11 | 216 | #define COAP_405_METHOD_NOT_ALLOWED (uint8_t)0x85 |
terencez | 0:f9d13e09cf11 | 217 | #define COAP_406_NOT_ACCEPTABLE (uint8_t)0x86 |
terence zhang | 3:a280069151ac | 218 | #define COAP_408_REQ_ENTITY_INCOMPLETE (uint8_t)0x88 |
terence zhang | 3:a280069151ac | 219 | #define COAP_412_PRECONDITION_FAILED (uint8_t)0x8C |
terence zhang | 3:a280069151ac | 220 | #define COAP_413_ENTITY_TOO_LARGE (uint8_t)0x8D |
terencez | 0:f9d13e09cf11 | 221 | #define COAP_500_INTERNAL_SERVER_ERROR (uint8_t)0xA0 |
terencez | 0:f9d13e09cf11 | 222 | #define COAP_501_NOT_IMPLEMENTED (uint8_t)0xA1 |
terencez | 0:f9d13e09cf11 | 223 | #define COAP_503_SERVICE_UNAVAILABLE (uint8_t)0xA3 |
terencez | 11:1fadb70654a6 | 224 | #endif |
terencez | 0:f9d13e09cf11 | 225 | |
terence zhang | 3:a280069151ac | 226 | /* |
terence zhang | 3:a280069151ac | 227 | * Standard Object IDs |
terence zhang | 3:a280069151ac | 228 | */ |
terence zhang | 3:a280069151ac | 229 | #define LWM2M_SECURITY_OBJECT_ID 0 |
terence zhang | 3:a280069151ac | 230 | #define LWM2M_SERVER_OBJECT_ID 1 |
terence zhang | 3:a280069151ac | 231 | #define LWM2M_ACL_OBJECT_ID 2 |
terence zhang | 3:a280069151ac | 232 | #define LWM2M_DEVICE_OBJECT_ID 3 |
terence zhang | 3:a280069151ac | 233 | #define LWM2M_CONN_MONITOR_OBJECT_ID 4 |
terence zhang | 3:a280069151ac | 234 | #define LWM2M_FIRMWARE_UPDATE_OBJECT_ID 5 |
terence zhang | 3:a280069151ac | 235 | #define LWM2M_LOCATION_OBJECT_ID 6 |
terence zhang | 3:a280069151ac | 236 | #define LWM2M_CONN_STATS_OBJECT_ID 7 |
terence zhang | 3:a280069151ac | 237 | |
terence zhang | 3:a280069151ac | 238 | /* |
terence zhang | 3:a280069151ac | 239 | * Ressource IDs for the LWM2M Security Object |
terence zhang | 3:a280069151ac | 240 | */ |
terence zhang | 3:a280069151ac | 241 | #define LWM2M_SECURITY_URI_ID 0 |
terence zhang | 3:a280069151ac | 242 | #define LWM2M_SECURITY_BOOTSTRAP_ID 1 |
terence zhang | 3:a280069151ac | 243 | #define LWM2M_SECURITY_SECURITY_ID 2 |
terence zhang | 3:a280069151ac | 244 | #define LWM2M_SECURITY_PUBLIC_KEY_ID 3 |
terence zhang | 3:a280069151ac | 245 | #define LWM2M_SECURITY_SERVER_PUBLIC_KEY_ID 4 |
terence zhang | 3:a280069151ac | 246 | #define LWM2M_SECURITY_SECRET_KEY_ID 5 |
terence zhang | 3:a280069151ac | 247 | #define LWM2M_SECURITY_SMS_SECURITY_ID 6 |
terence zhang | 3:a280069151ac | 248 | #define LWM2M_SECURITY_SMS_KEY_PARAM_ID 7 |
terence zhang | 3:a280069151ac | 249 | #define LWM2M_SECURITY_SMS_SECRET_KEY_ID 8 |
terence zhang | 3:a280069151ac | 250 | #define LWM2M_SECURITY_SMS_SERVER_NUMBER_ID 9 |
terence zhang | 3:a280069151ac | 251 | #define LWM2M_SECURITY_SHORT_SERVER_ID 10 |
terence zhang | 3:a280069151ac | 252 | #define LWM2M_SECURITY_HOLD_OFF_ID 11 |
terence zhang | 3:a280069151ac | 253 | #define LWM2M_SECURITY_BOOTSTRAP_TIMEOUT_ID 12 |
terence zhang | 3:a280069151ac | 254 | |
terence zhang | 3:a280069151ac | 255 | /* |
terence zhang | 3:a280069151ac | 256 | * Ressource IDs for the LWM2M Server Object |
terence zhang | 3:a280069151ac | 257 | */ |
terence zhang | 3:a280069151ac | 258 | #define LWM2M_SERVER_SHORT_ID_ID 0 |
terence zhang | 3:a280069151ac | 259 | #define LWM2M_SERVER_LIFETIME_ID 1 |
terence zhang | 3:a280069151ac | 260 | #define LWM2M_SERVER_MIN_PERIOD_ID 2 |
terence zhang | 3:a280069151ac | 261 | #define LWM2M_SERVER_MAX_PERIOD_ID 3 |
terence zhang | 3:a280069151ac | 262 | #define LWM2M_SERVER_DISABLE_ID 4 |
terence zhang | 3:a280069151ac | 263 | #define LWM2M_SERVER_TIMEOUT_ID 5 |
terence zhang | 3:a280069151ac | 264 | #define LWM2M_SERVER_STORING_ID 6 |
terence zhang | 3:a280069151ac | 265 | #define LWM2M_SERVER_BINDING_ID 7 |
terence zhang | 3:a280069151ac | 266 | #define LWM2M_SERVER_UPDATE_ID 8 |
terence zhang | 3:a280069151ac | 267 | |
terence zhang | 3:a280069151ac | 268 | #define LWM2M_SECURITY_MODE_PRE_SHARED_KEY 0 |
terence zhang | 3:a280069151ac | 269 | #define LWM2M_SECURITY_MODE_RAW_PUBLIC_KEY 1 |
terence zhang | 3:a280069151ac | 270 | #define LWM2M_SECURITY_MODE_CERTIFICATE 2 |
terence zhang | 3:a280069151ac | 271 | #define LWM2M_SECURITY_MODE_NONE 3 |
terence zhang | 3:a280069151ac | 272 | |
terencez | 0:f9d13e09cf11 | 273 | |
terencez | 0:f9d13e09cf11 | 274 | /* |
terencez | 0:f9d13e09cf11 | 275 | * Utility functions for sorted linked list |
terencez | 0:f9d13e09cf11 | 276 | */ |
terencez | 0:f9d13e09cf11 | 277 | |
terencez | 0:f9d13e09cf11 | 278 | typedef struct _lwm2m_list_t |
terencez | 0:f9d13e09cf11 | 279 | { |
terencez | 0:f9d13e09cf11 | 280 | struct _lwm2m_list_t * next; |
terencez | 0:f9d13e09cf11 | 281 | uint16_t id; |
terencez | 0:f9d13e09cf11 | 282 | } lwm2m_list_t; |
terencez | 0:f9d13e09cf11 | 283 | |
terencez | 0:f9d13e09cf11 | 284 | // defined in list.c |
terencez | 0:f9d13e09cf11 | 285 | // Add 'node' to the list 'head' and return the new list |
terencez | 0:f9d13e09cf11 | 286 | lwm2m_list_t * lwm2m_list_add(lwm2m_list_t * head, lwm2m_list_t * node); |
terencez | 0:f9d13e09cf11 | 287 | // Return the node with ID 'id' from the list 'head' or NULL if not found |
terencez | 0:f9d13e09cf11 | 288 | lwm2m_list_t * lwm2m_list_find(lwm2m_list_t * head, uint16_t id); |
terencez | 0:f9d13e09cf11 | 289 | // Remove the node with ID 'id' from the list 'head' and return the new list |
terencez | 0:f9d13e09cf11 | 290 | lwm2m_list_t * lwm2m_list_remove(lwm2m_list_t * head, uint16_t id, lwm2m_list_t ** nodeP); |
terencez | 0:f9d13e09cf11 | 291 | // Return the lowest unused ID in the list 'head' |
terencez | 0:f9d13e09cf11 | 292 | uint16_t lwm2m_list_newId(lwm2m_list_t * head); |
terence zhang | 3:a280069151ac | 293 | // Free a list. Do not use if nodes contain allocated pointers as it calls lwm2m_free on nodes only. |
terence zhang | 3:a280069151ac | 294 | // If the nodes of the list need to do more than just "free()" their instances, don't use lwm2m_list_free(). |
terence zhang | 3:a280069151ac | 295 | void lwm2m_list_free(lwm2m_list_t * head); |
terencez | 0:f9d13e09cf11 | 296 | |
terencez | 0:f9d13e09cf11 | 297 | #define LWM2M_LIST_ADD(H,N) lwm2m_list_add((lwm2m_list_t *)H, (lwm2m_list_t *)N); |
terencez | 0:f9d13e09cf11 | 298 | #define LWM2M_LIST_RM(H,I,N) lwm2m_list_remove((lwm2m_list_t *)H, I, (lwm2m_list_t **)N); |
terence zhang | 3:a280069151ac | 299 | #define LWM2M_LIST_FIND(H,I) lwm2m_list_find((lwm2m_list_t *)H, I) |
terence zhang | 3:a280069151ac | 300 | #define LWM2M_LIST_FREE(H) lwm2m_list_free((lwm2m_list_t *)H) |
terencez | 0:f9d13e09cf11 | 301 | |
terencez | 16:31c387e94b6d | 302 | |
terencez | 16:31c387e94b6d | 303 | |
terencez | 0:f9d13e09cf11 | 304 | /* |
terencez | 0:f9d13e09cf11 | 305 | * URI |
terencez | 0:f9d13e09cf11 | 306 | * |
terencez | 0:f9d13e09cf11 | 307 | * objectId is always set |
terence zhang | 3:a280069151ac | 308 | * instanceId or resourceId are set according to the flag bit-field |
terencez | 0:f9d13e09cf11 | 309 | * |
terencez | 0:f9d13e09cf11 | 310 | */ |
terencez | 0:f9d13e09cf11 | 311 | |
terencez | 0:f9d13e09cf11 | 312 | #define LWM2M_MAX_ID ((uint16_t)0xFFFF) |
terencez | 0:f9d13e09cf11 | 313 | |
terencez | 0:f9d13e09cf11 | 314 | #define LWM2M_URI_FLAG_OBJECT_ID (uint8_t)0x04 |
terencez | 0:f9d13e09cf11 | 315 | #define LWM2M_URI_FLAG_INSTANCE_ID (uint8_t)0x02 |
terencez | 0:f9d13e09cf11 | 316 | #define LWM2M_URI_FLAG_RESOURCE_ID (uint8_t)0x01 |
terencez | 0:f9d13e09cf11 | 317 | |
terence zhang | 3:a280069151ac | 318 | #define LWM2M_URI_IS_SET_INSTANCE(uri) (((uri)->flag & LWM2M_URI_FLAG_INSTANCE_ID) != 0) |
terence zhang | 3:a280069151ac | 319 | #define LWM2M_URI_IS_SET_RESOURCE(uri) (((uri)->flag & LWM2M_URI_FLAG_RESOURCE_ID) != 0) |
terencez | 0:f9d13e09cf11 | 320 | |
terencez | 0:f9d13e09cf11 | 321 | typedef struct |
terencez | 0:f9d13e09cf11 | 322 | { |
terencez | 0:f9d13e09cf11 | 323 | uint8_t flag; // indicates which segments are set |
terencez | 0:f9d13e09cf11 | 324 | uint16_t objectId; |
terencez | 0:f9d13e09cf11 | 325 | uint16_t instanceId; |
terencez | 0:f9d13e09cf11 | 326 | uint16_t resourceId; |
terencez | 0:f9d13e09cf11 | 327 | } lwm2m_uri_t; |
terencez | 0:f9d13e09cf11 | 328 | |
terencez | 0:f9d13e09cf11 | 329 | |
terencez | 0:f9d13e09cf11 | 330 | #define LWM2M_STRING_ID_MAX_LEN 6 |
terencez | 0:f9d13e09cf11 | 331 | |
terencez | 0:f9d13e09cf11 | 332 | // Parse an URI in LWM2M format and fill the lwm2m_uri_t. |
terencez | 0:f9d13e09cf11 | 333 | // Return the number of characters read from buffer or 0 in case of error. |
terencez | 0:f9d13e09cf11 | 334 | // Valid URIs: /1, /1/, /1/2, /1/2/, /1/2/3 |
terencez | 0:f9d13e09cf11 | 335 | // Invalid URIs: /, //, //2, /1//, /1//3, /1/2/3/, /1/2/3/4 |
terence zhang | 3:a280069151ac | 336 | int lwm2m_stringToUri(const char * buffer, size_t buffer_len, lwm2m_uri_t * uriP); |
terence zhang | 3:a280069151ac | 337 | |
terence zhang | 3:a280069151ac | 338 | /* |
terence zhang | 3:a280069151ac | 339 | * The lwm2m_data_t is used to store LWM2M resource values in a hierarchical way. |
terence zhang | 3:a280069151ac | 340 | * Depending on the type the value is different: |
terence zhang | 3:a280069151ac | 341 | * - LWM2M_TYPE_OBJECT, LWM2M_TYPE_OBJECT_INSTANCE, LWM2M_TYPE_MULTIPLE_RESOURCE: value.asChildren |
terence zhang | 3:a280069151ac | 342 | * - LWM2M_TYPE_STRING, LWM2M_TYPE_OPAQUE: value.asBuffer |
terence zhang | 3:a280069151ac | 343 | * - LWM2M_TYPE_INTEGER, LWM2M_TYPE_TIME: value.asInteger |
terence zhang | 3:a280069151ac | 344 | * - LWM2M_TYPE_FLOAT: value.asFloat |
terence zhang | 3:a280069151ac | 345 | * - LWM2M_TYPE_BOOLEAN: value.asBoolean |
terence zhang | 3:a280069151ac | 346 | * |
terence zhang | 3:a280069151ac | 347 | * LWM2M_TYPE_STRING is also used when the data is in text format. |
terence zhang | 3:a280069151ac | 348 | */ |
terence zhang | 3:a280069151ac | 349 | |
terence zhang | 3:a280069151ac | 350 | typedef enum |
terence zhang | 3:a280069151ac | 351 | { |
terence zhang | 3:a280069151ac | 352 | LWM2M_TYPE_UNDEFINED = 0, |
terence zhang | 3:a280069151ac | 353 | LWM2M_TYPE_OBJECT, |
terence zhang | 3:a280069151ac | 354 | LWM2M_TYPE_OBJECT_INSTANCE, |
terence zhang | 3:a280069151ac | 355 | LWM2M_TYPE_MULTIPLE_RESOURCE, |
terence zhang | 3:a280069151ac | 356 | LWM2M_TYPE_STRING, |
terence zhang | 3:a280069151ac | 357 | LWM2M_TYPE_OPAQUE, |
terence zhang | 3:a280069151ac | 358 | LWM2M_TYPE_INTEGER, |
terence zhang | 3:a280069151ac | 359 | LWM2M_TYPE_FLOAT, |
terence zhang | 3:a280069151ac | 360 | LWM2M_TYPE_BOOLEAN, |
terence zhang | 3:a280069151ac | 361 | |
terence zhang | 3:a280069151ac | 362 | LWM2M_TYPE_OBJECT_LINK |
terence zhang | 3:a280069151ac | 363 | } lwm2m_data_type_t; |
terence zhang | 3:a280069151ac | 364 | |
terence zhang | 3:a280069151ac | 365 | typedef struct _lwm2m_data_t lwm2m_data_t; |
terence zhang | 3:a280069151ac | 366 | |
terence zhang | 3:a280069151ac | 367 | struct _lwm2m_data_t |
terence zhang | 3:a280069151ac | 368 | { |
terence zhang | 3:a280069151ac | 369 | lwm2m_data_type_t type; |
terence zhang | 3:a280069151ac | 370 | uint16_t id; |
terence zhang | 3:a280069151ac | 371 | union |
terence zhang | 3:a280069151ac | 372 | { |
terence zhang | 3:a280069151ac | 373 | bool asBoolean; |
terence zhang | 3:a280069151ac | 374 | int64_t asInteger; |
terence zhang | 3:a280069151ac | 375 | double asFloat; |
terence zhang | 3:a280069151ac | 376 | struct |
terence zhang | 3:a280069151ac | 377 | { |
terence zhang | 3:a280069151ac | 378 | size_t length; |
terence zhang | 3:a280069151ac | 379 | uint8_t * buffer; |
terence zhang | 3:a280069151ac | 380 | } asBuffer; |
terence zhang | 3:a280069151ac | 381 | struct |
terence zhang | 3:a280069151ac | 382 | { |
terence zhang | 3:a280069151ac | 383 | size_t count; |
terence zhang | 3:a280069151ac | 384 | lwm2m_data_t * array; |
terence zhang | 3:a280069151ac | 385 | } asChildren; |
terence zhang | 3:a280069151ac | 386 | struct |
terence zhang | 3:a280069151ac | 387 | { |
terence zhang | 3:a280069151ac | 388 | uint16_t objectId; |
terence zhang | 3:a280069151ac | 389 | uint16_t objectInstanceId; |
terence zhang | 3:a280069151ac | 390 | } asObjLink; |
terence zhang | 3:a280069151ac | 391 | } value; |
terence zhang | 3:a280069151ac | 392 | }; |
terence zhang | 3:a280069151ac | 393 | |
terence zhang | 3:a280069151ac | 394 | typedef enum |
terence zhang | 3:a280069151ac | 395 | { |
terence zhang | 3:a280069151ac | 396 | LWM2M_CONTENT_TEXT = 0, // Also used as undefined |
terence zhang | 3:a280069151ac | 397 | LWM2M_CONTENT_LINK = 40, |
terence zhang | 3:a280069151ac | 398 | LWM2M_CONTENT_OPAQUE = 42, |
terence zhang | 3:a280069151ac | 399 | LWM2M_CONTENT_TLV_OLD = 1542, // Keep old value for backward-compatibility |
terence zhang | 3:a280069151ac | 400 | LWM2M_CONTENT_TLV = 11542, |
terence zhang | 3:a280069151ac | 401 | LWM2M_CONTENT_JSON_OLD = 1543, // Keep old value for backward-compatibility |
terence zhang | 3:a280069151ac | 402 | LWM2M_CONTENT_JSON = 11543 |
terence zhang | 3:a280069151ac | 403 | } lwm2m_media_type_t; |
terence zhang | 3:a280069151ac | 404 | |
terence zhang | 3:a280069151ac | 405 | lwm2m_data_t * lwm2m_data_new(int size); |
terence zhang | 3:a280069151ac | 406 | int lwm2m_data_parse(lwm2m_uri_t * uriP, uint8_t * buffer, size_t bufferLen, lwm2m_media_type_t format, lwm2m_data_t ** dataP); |
terence zhang | 3:a280069151ac | 407 | int lwm2m_data_serialize(lwm2m_uri_t * uriP, int size, lwm2m_data_t * dataP, lwm2m_media_type_t * formatP, uint8_t ** bufferP); |
terence zhang | 3:a280069151ac | 408 | void lwm2m_data_free(int size, lwm2m_data_t * dataP); |
terence zhang | 3:a280069151ac | 409 | |
terence zhang | 3:a280069151ac | 410 | void lwm2m_data_encode_string(const char * string, lwm2m_data_t * dataP); |
terence zhang | 3:a280069151ac | 411 | void lwm2m_data_encode_nstring(const char * string, size_t length, lwm2m_data_t * dataP); |
terence zhang | 3:a280069151ac | 412 | void lwm2m_data_encode_opaque(uint8_t * buffer, size_t length, lwm2m_data_t * dataP); |
terence zhang | 3:a280069151ac | 413 | void lwm2m_data_encode_int(int64_t value, lwm2m_data_t * dataP); |
terence zhang | 3:a280069151ac | 414 | int lwm2m_data_decode_int(const lwm2m_data_t * dataP, int64_t * valueP); |
terence zhang | 3:a280069151ac | 415 | void lwm2m_data_encode_float(double value, lwm2m_data_t * dataP); |
terence zhang | 3:a280069151ac | 416 | int lwm2m_data_decode_float(const lwm2m_data_t * dataP, double * valueP); |
terence zhang | 3:a280069151ac | 417 | void lwm2m_data_encode_bool(bool value, lwm2m_data_t * dataP); |
terence zhang | 3:a280069151ac | 418 | int lwm2m_data_decode_bool(const lwm2m_data_t * dataP, bool * valueP); |
terence zhang | 3:a280069151ac | 419 | void lwm2m_data_encode_objlink(uint16_t objectId, uint16_t objectInstanceId, lwm2m_data_t * dataP); |
terence zhang | 3:a280069151ac | 420 | void lwm2m_data_encode_instances(lwm2m_data_t * subDataP, size_t count, lwm2m_data_t * dataP); |
terence zhang | 3:a280069151ac | 421 | void lwm2m_data_include(lwm2m_data_t * subDataP, size_t count, lwm2m_data_t * dataP); |
terence zhang | 3:a280069151ac | 422 | |
terence zhang | 3:a280069151ac | 423 | |
terence zhang | 3:a280069151ac | 424 | /* |
terence zhang | 3:a280069151ac | 425 | * Utility function to parse TLV buffers directly |
terence zhang | 3:a280069151ac | 426 | * |
terence zhang | 3:a280069151ac | 427 | * Returned value: number of bytes parsed |
terence zhang | 3:a280069151ac | 428 | * buffer: buffer to parse |
terence zhang | 3:a280069151ac | 429 | * buffer_len: length in bytes of buffer |
terence zhang | 3:a280069151ac | 430 | * oType: (OUT) type of the parsed TLV record. can be: |
terence zhang | 3:a280069151ac | 431 | * - LWM2M_TYPE_OBJECT |
terence zhang | 3:a280069151ac | 432 | * - LWM2M_TYPE_OBJECT_INSTANCE |
terence zhang | 3:a280069151ac | 433 | * - LWM2M_TYPE_MULTIPLE_RESOURCE |
terence zhang | 3:a280069151ac | 434 | * - LWM2M_TYPE_OPAQUE |
terence zhang | 3:a280069151ac | 435 | * oID: (OUT) ID of the parsed TLV record |
terence zhang | 3:a280069151ac | 436 | * oDataIndex: (OUT) index of the data of the parsed TLV record in the buffer |
terence zhang | 3:a280069151ac | 437 | * oDataLen: (OUT) length of the data of the parsed TLV record |
terence zhang | 3:a280069151ac | 438 | */ |
terence zhang | 3:a280069151ac | 439 | |
terence zhang | 3:a280069151ac | 440 | #define LWM2M_TLV_HEADER_MAX_LENGTH 6 |
terence zhang | 3:a280069151ac | 441 | |
terence zhang | 3:a280069151ac | 442 | int lwm2m_decode_TLV(const uint8_t * buffer, size_t buffer_len, lwm2m_data_type_t * oType, uint16_t * oID, size_t * oDataIndex, size_t * oDataLen); |
terencez | 0:f9d13e09cf11 | 443 | |
terencez | 0:f9d13e09cf11 | 444 | |
terencez | 0:f9d13e09cf11 | 445 | /* |
terencez | 0:f9d13e09cf11 | 446 | * LWM2M Objects |
terencez | 0:f9d13e09cf11 | 447 | * |
terencez | 0:f9d13e09cf11 | 448 | * For the read callback, if *numDataP is not zero, *dataArrayP is pre-allocated |
terencez | 0:f9d13e09cf11 | 449 | * and contains the list of resources to read. |
terencez | 0:f9d13e09cf11 | 450 | * |
terencez | 0:f9d13e09cf11 | 451 | */ |
terencez | 0:f9d13e09cf11 | 452 | |
terencez | 0:f9d13e09cf11 | 453 | typedef struct _lwm2m_object_t lwm2m_object_t; |
terencez | 0:f9d13e09cf11 | 454 | |
terence zhang | 3:a280069151ac | 455 | typedef uint8_t (*lwm2m_read_callback_t) (uint16_t instanceId, int * numDataP, lwm2m_data_t ** dataArrayP, lwm2m_object_t * objectP); |
terence zhang | 3:a280069151ac | 456 | typedef uint8_t (*lwm2m_discover_callback_t) (uint16_t instanceId, int * numDataP, lwm2m_data_t ** dataArrayP, lwm2m_object_t * objectP); |
terence zhang | 3:a280069151ac | 457 | typedef uint8_t (*lwm2m_write_callback_t) (uint16_t instanceId, int numData, lwm2m_data_t * dataArray, lwm2m_object_t * objectP); |
terence zhang | 3:a280069151ac | 458 | typedef uint8_t (*lwm2m_execute_callback_t) (uint16_t instanceId, uint16_t resourceId, uint8_t * buffer, int length, lwm2m_object_t * objectP); |
terence zhang | 3:a280069151ac | 459 | typedef uint8_t (*lwm2m_create_callback_t) (uint16_t instanceId, int numData, lwm2m_data_t * dataArray, lwm2m_object_t * objectP); |
terencez | 0:f9d13e09cf11 | 460 | typedef uint8_t (*lwm2m_delete_callback_t) (uint16_t instanceId, lwm2m_object_t * objectP); |
terencez | 0:f9d13e09cf11 | 461 | |
terencez | 0:f9d13e09cf11 | 462 | struct _lwm2m_object_t |
terencez | 0:f9d13e09cf11 | 463 | { |
terence zhang | 3:a280069151ac | 464 | struct _lwm2m_object_t * next; // for internal use only. |
terence zhang | 3:a280069151ac | 465 | uint16_t objID; |
terence zhang | 3:a280069151ac | 466 | lwm2m_list_t * instanceList; |
terence zhang | 3:a280069151ac | 467 | lwm2m_read_callback_t readFunc; |
terence zhang | 3:a280069151ac | 468 | lwm2m_write_callback_t writeFunc; |
terence zhang | 3:a280069151ac | 469 | lwm2m_execute_callback_t executeFunc; |
terence zhang | 3:a280069151ac | 470 | lwm2m_create_callback_t createFunc; |
terence zhang | 3:a280069151ac | 471 | lwm2m_delete_callback_t deleteFunc; |
terence zhang | 3:a280069151ac | 472 | lwm2m_discover_callback_t discoverFunc; |
terence zhang | 3:a280069151ac | 473 | void * userData; |
terencez | 0:f9d13e09cf11 | 474 | }; |
terencez | 0:f9d13e09cf11 | 475 | |
terencez | 0:f9d13e09cf11 | 476 | /* |
terencez | 0:f9d13e09cf11 | 477 | * LWM2M Servers |
terencez | 0:f9d13e09cf11 | 478 | * |
terencez | 0:f9d13e09cf11 | 479 | * Since LWM2M Server Object instances are not accessible to LWM2M servers, |
terencez | 0:f9d13e09cf11 | 480 | * there is no need to store them as lwm2m_objects_t |
terencez | 0:f9d13e09cf11 | 481 | */ |
terencez | 0:f9d13e09cf11 | 482 | |
terencez | 0:f9d13e09cf11 | 483 | typedef enum |
terencez | 0:f9d13e09cf11 | 484 | { |
terence zhang | 3:a280069151ac | 485 | STATE_DEREGISTERED = 0, // not registered or boostrap not started |
terence zhang | 3:a280069151ac | 486 | STATE_REG_PENDING, // registration pending |
terence zhang | 3:a280069151ac | 487 | STATE_REGISTERED, // successfully registered |
terence zhang | 3:a280069151ac | 488 | STATE_REG_FAILED, // last registration failed |
terence zhang | 3:a280069151ac | 489 | STATE_REG_UPDATE_PENDING, // registration update pending |
terence zhang | 3:a280069151ac | 490 | STATE_REG_UPDATE_NEEDED, // registration update required |
terence zhang | 3:a280069151ac | 491 | STATE_REG_FULL_UPDATE_NEEDED, // registration update with objects required |
terence zhang | 3:a280069151ac | 492 | STATE_DEREG_PENDING, // deregistration pending |
terence zhang | 3:a280069151ac | 493 | STATE_BS_HOLD_OFF, // bootstrap hold off time |
terence zhang | 3:a280069151ac | 494 | STATE_BS_INITIATED, // bootstrap request sent |
terence zhang | 3:a280069151ac | 495 | STATE_BS_PENDING, // boostrap ongoing |
terence zhang | 3:a280069151ac | 496 | STATE_BS_FINISHING, // boostrap finish received |
terence zhang | 3:a280069151ac | 497 | STATE_BS_FINISHED, // bootstrap done |
terence zhang | 3:a280069151ac | 498 | STATE_BS_FAILING, // bootstrap error occurred |
terence zhang | 3:a280069151ac | 499 | STATE_BS_FAILED, // bootstrap failed |
terencez | 0:f9d13e09cf11 | 500 | } lwm2m_status_t; |
terencez | 0:f9d13e09cf11 | 501 | |
terencez | 0:f9d13e09cf11 | 502 | typedef enum |
terencez | 0:f9d13e09cf11 | 503 | { |
terencez | 0:f9d13e09cf11 | 504 | BINDING_UNKNOWN = 0, |
terencez | 0:f9d13e09cf11 | 505 | BINDING_U, // UDP |
terencez | 0:f9d13e09cf11 | 506 | BINDING_UQ, // UDP queue mode |
terencez | 0:f9d13e09cf11 | 507 | BINDING_S, // SMS |
terencez | 0:f9d13e09cf11 | 508 | BINDING_SQ, // SMS queue mode |
terencez | 0:f9d13e09cf11 | 509 | BINDING_US, // UDP plus SMS |
terencez | 0:f9d13e09cf11 | 510 | BINDING_UQS // UDP queue mode plus SMS |
terencez | 0:f9d13e09cf11 | 511 | } lwm2m_binding_t; |
terencez | 0:f9d13e09cf11 | 512 | |
terence zhang | 3:a280069151ac | 513 | /* |
terence zhang | 3:a280069151ac | 514 | * LWM2M block1 data |
terence zhang | 3:a280069151ac | 515 | * |
terence zhang | 3:a280069151ac | 516 | * Temporary data needed to handle block1 request. |
terence zhang | 3:a280069151ac | 517 | * Currently support only one block1 request by server. |
terence zhang | 3:a280069151ac | 518 | */ |
terence zhang | 3:a280069151ac | 519 | typedef struct _lwm2m_block1_data_ lwm2m_block1_data_t; |
terence zhang | 3:a280069151ac | 520 | |
terence zhang | 3:a280069151ac | 521 | struct _lwm2m_block1_data_ |
terence zhang | 3:a280069151ac | 522 | { |
terence zhang | 3:a280069151ac | 523 | uint8_t * block1buffer; // data buffer |
terence zhang | 3:a280069151ac | 524 | size_t block1bufferSize; // buffer size |
terence zhang | 3:a280069151ac | 525 | uint16_t lastmid; // mid of the last message received |
terence zhang | 3:a280069151ac | 526 | }; |
terence zhang | 3:a280069151ac | 527 | |
terencez | 14:ec9e195830ff | 528 | /* |
terencez | 14:ec9e195830ff | 529 | * LWM2M Servers |
terencez | 14:ec9e195830ff | 530 | * |
terencez | 14:ec9e195830ff | 531 | * Since LWM2M Server Object instances are not accessible to LWM2M servers, |
terencez | 14:ec9e195830ff | 532 | * there is no need to store them as lwm2m_objects_t |
terencez | 14:ec9e195830ff | 533 | */ |
terencez | 14:ec9e195830ff | 534 | |
terencez | 14:ec9e195830ff | 535 | typedef enum |
terencez | 14:ec9e195830ff | 536 | { |
terencez | 14:ec9e195830ff | 537 | SEC_NONE = 0, |
terencez | 14:ec9e195830ff | 538 | SEC_PRE_SHARED_KEY, |
terencez | 14:ec9e195830ff | 539 | SEC_RAW_PUBLIC_KEY, |
terencez | 14:ec9e195830ff | 540 | SEC_CERTIFICATE |
terencez | 14:ec9e195830ff | 541 | } lwm2m_security_mode_t; |
terencez | 14:ec9e195830ff | 542 | |
terencez | 14:ec9e195830ff | 543 | typedef struct |
terencez | 14:ec9e195830ff | 544 | { |
terencez | 14:ec9e195830ff | 545 | lwm2m_security_mode_t mode; |
terencez | 14:ec9e195830ff | 546 | size_t publicKeyLength; |
terencez | 14:ec9e195830ff | 547 | uint8_t * publicKey; |
terencez | 14:ec9e195830ff | 548 | size_t privateKeyLength; |
terencez | 14:ec9e195830ff | 549 | uint8_t * privateKey; |
terencez | 14:ec9e195830ff | 550 | } lwm2m_security_t; |
terencez | 14:ec9e195830ff | 551 | |
terencez | 14:ec9e195830ff | 552 | |
terencez | 14:ec9e195830ff | 553 | |
terencez | 0:f9d13e09cf11 | 554 | typedef struct _lwm2m_server_ |
terencez | 0:f9d13e09cf11 | 555 | { |
terence zhang | 3:a280069151ac | 556 | struct _lwm2m_server_ * next; // matches lwm2m_list_t::next |
terence zhang | 3:a280069151ac | 557 | uint16_t secObjInstID; // matches lwm2m_list_t::id |
terence zhang | 3:a280069151ac | 558 | uint16_t shortID; // servers short ID, may be 0 for bootstrap server |
terence zhang | 3:a280069151ac | 559 | time_t lifetime; // lifetime of the registration in sec or 0 if default value (86400 sec), also used as hold off time for bootstrap servers |
terence zhang | 3:a280069151ac | 560 | time_t registration; // date of the last registration in sec or end of client hold off time for bootstrap servers |
terence zhang | 3:a280069151ac | 561 | lwm2m_binding_t binding; // client connection mode with this server |
terence zhang | 3:a280069151ac | 562 | void * sessionH; |
terence zhang | 3:a280069151ac | 563 | lwm2m_status_t status; |
terence zhang | 3:a280069151ac | 564 | char * location; |
terence zhang | 3:a280069151ac | 565 | bool dirty; |
terence zhang | 3:a280069151ac | 566 | lwm2m_block1_data_t * block1Data; // buffer to handle block1 data, should be replace by a list to support several block1 transfer by server. |
terencez | 14:ec9e195830ff | 567 | lwm2m_security_t security; |
terencez | 14:ec9e195830ff | 568 | char * sms; |
terencez | 0:f9d13e09cf11 | 569 | } lwm2m_server_t; |
terencez | 0:f9d13e09cf11 | 570 | |
terencez | 0:f9d13e09cf11 | 571 | |
terencez | 0:f9d13e09cf11 | 572 | /* |
terencez | 0:f9d13e09cf11 | 573 | * LWM2M result callback |
terencez | 0:f9d13e09cf11 | 574 | * |
terencez | 0:f9d13e09cf11 | 575 | * When used with an observe, if 'data' is not nil, 'status' holds the observe counter. |
terencez | 0:f9d13e09cf11 | 576 | */ |
terence zhang | 3:a280069151ac | 577 | typedef void (*lwm2m_result_callback_t) (uint16_t clientID, lwm2m_uri_t * uriP, int status, lwm2m_media_type_t format, uint8_t * data, int dataLength, void * userData); |
terencez | 0:f9d13e09cf11 | 578 | |
terencez | 0:f9d13e09cf11 | 579 | /* |
terencez | 0:f9d13e09cf11 | 580 | * LWM2M Observations |
terencez | 0:f9d13e09cf11 | 581 | * |
terencez | 0:f9d13e09cf11 | 582 | * Used to store observation of remote clients resources. |
terencez | 0:f9d13e09cf11 | 583 | * status STATE_REG_PENDING means the observe request was sent to the client but not yet answered. |
terencez | 0:f9d13e09cf11 | 584 | * status STATE_REGISTERED means the client acknowledged the observe request. |
terence zhang | 3:a280069151ac | 585 | * status STATE_DEREG_PENDING means the user canceled the request before the client answered it. |
terencez | 0:f9d13e09cf11 | 586 | */ |
terencez | 0:f9d13e09cf11 | 587 | |
terencez | 0:f9d13e09cf11 | 588 | typedef struct _lwm2m_observation_ |
terencez | 0:f9d13e09cf11 | 589 | { |
terencez | 0:f9d13e09cf11 | 590 | struct _lwm2m_observation_ * next; // matches lwm2m_list_t::next |
terencez | 0:f9d13e09cf11 | 591 | uint16_t id; // matches lwm2m_list_t::id |
terencez | 0:f9d13e09cf11 | 592 | struct _lwm2m_client_ * clientP; |
terencez | 0:f9d13e09cf11 | 593 | lwm2m_uri_t uri; |
terence zhang | 3:a280069151ac | 594 | lwm2m_status_t status; |
terencez | 0:f9d13e09cf11 | 595 | lwm2m_result_callback_t callback; |
terencez | 0:f9d13e09cf11 | 596 | void * userData; |
terencez | 0:f9d13e09cf11 | 597 | } lwm2m_observation_t; |
terencez | 0:f9d13e09cf11 | 598 | |
terencez | 0:f9d13e09cf11 | 599 | /* |
terence zhang | 3:a280069151ac | 600 | * LWM2M Link Attributes |
terence zhang | 3:a280069151ac | 601 | * |
terence zhang | 3:a280069151ac | 602 | * Used for observation parameters. |
terence zhang | 3:a280069151ac | 603 | * |
terence zhang | 3:a280069151ac | 604 | */ |
terence zhang | 3:a280069151ac | 605 | |
terence zhang | 3:a280069151ac | 606 | #define LWM2M_ATTR_FLAG_MIN_PERIOD (uint8_t)0x01 |
terence zhang | 3:a280069151ac | 607 | #define LWM2M_ATTR_FLAG_MAX_PERIOD (uint8_t)0x02 |
terence zhang | 3:a280069151ac | 608 | #define LWM2M_ATTR_FLAG_GREATER_THAN (uint8_t)0x04 |
terence zhang | 3:a280069151ac | 609 | #define LWM2M_ATTR_FLAG_LESS_THAN (uint8_t)0x08 |
terence zhang | 3:a280069151ac | 610 | #define LWM2M_ATTR_FLAG_STEP (uint8_t)0x10 |
terence zhang | 3:a280069151ac | 611 | |
terence zhang | 3:a280069151ac | 612 | typedef struct |
terence zhang | 3:a280069151ac | 613 | { |
terence zhang | 3:a280069151ac | 614 | uint8_t toSet; |
terence zhang | 3:a280069151ac | 615 | uint8_t toClear; |
terence zhang | 3:a280069151ac | 616 | uint32_t minPeriod; |
terence zhang | 3:a280069151ac | 617 | uint32_t maxPeriod; |
terence zhang | 3:a280069151ac | 618 | double greaterThan; |
terence zhang | 3:a280069151ac | 619 | double lessThan; |
terence zhang | 3:a280069151ac | 620 | double step; |
terence zhang | 3:a280069151ac | 621 | } lwm2m_attributes_t; |
terence zhang | 3:a280069151ac | 622 | |
terence zhang | 3:a280069151ac | 623 | /* |
terencez | 0:f9d13e09cf11 | 624 | * LWM2M Clients |
terencez | 0:f9d13e09cf11 | 625 | * |
terencez | 0:f9d13e09cf11 | 626 | * Be careful not to mix lwm2m_client_object_t used to store list of objects of remote clients |
terencez | 0:f9d13e09cf11 | 627 | * and lwm2m_object_t describing objects exposed to remote servers. |
terencez | 0:f9d13e09cf11 | 628 | * |
terencez | 0:f9d13e09cf11 | 629 | */ |
terencez | 0:f9d13e09cf11 | 630 | |
terencez | 0:f9d13e09cf11 | 631 | typedef struct _lwm2m_client_object_ |
terencez | 0:f9d13e09cf11 | 632 | { |
terencez | 0:f9d13e09cf11 | 633 | struct _lwm2m_client_object_ * next; // matches lwm2m_list_t::next |
terencez | 0:f9d13e09cf11 | 634 | uint16_t id; // matches lwm2m_list_t::id |
terencez | 0:f9d13e09cf11 | 635 | lwm2m_list_t * instanceList; |
terencez | 0:f9d13e09cf11 | 636 | } lwm2m_client_object_t; |
terencez | 0:f9d13e09cf11 | 637 | |
terencez | 0:f9d13e09cf11 | 638 | typedef struct _lwm2m_client_ |
terencez | 0:f9d13e09cf11 | 639 | { |
terencez | 0:f9d13e09cf11 | 640 | struct _lwm2m_client_ * next; // matches lwm2m_list_t::next |
terencez | 0:f9d13e09cf11 | 641 | uint16_t internalID; // matches lwm2m_list_t::id |
terencez | 0:f9d13e09cf11 | 642 | char * name; |
terencez | 0:f9d13e09cf11 | 643 | lwm2m_binding_t binding; |
terencez | 0:f9d13e09cf11 | 644 | char * msisdn; |
terence zhang | 3:a280069151ac | 645 | char * altPath; |
terence zhang | 3:a280069151ac | 646 | bool supportJSON; |
terencez | 0:f9d13e09cf11 | 647 | uint32_t lifetime; |
terencez | 0:f9d13e09cf11 | 648 | time_t endOfLife; |
terencez | 0:f9d13e09cf11 | 649 | void * sessionH; |
terencez | 0:f9d13e09cf11 | 650 | lwm2m_client_object_t * objectList; |
terencez | 0:f9d13e09cf11 | 651 | lwm2m_observation_t * observationList; |
terencez | 0:f9d13e09cf11 | 652 | } lwm2m_client_t; |
terencez | 0:f9d13e09cf11 | 653 | |
terencez | 0:f9d13e09cf11 | 654 | |
terencez | 0:f9d13e09cf11 | 655 | /* |
terencez | 0:f9d13e09cf11 | 656 | * LWM2M transaction |
terencez | 0:f9d13e09cf11 | 657 | * |
terencez | 0:f9d13e09cf11 | 658 | * Adaptation of Erbium's coap_transaction_t |
terencez | 0:f9d13e09cf11 | 659 | */ |
terencez | 0:f9d13e09cf11 | 660 | |
terencez | 0:f9d13e09cf11 | 661 | typedef struct _lwm2m_transaction_ lwm2m_transaction_t; |
terencez | 0:f9d13e09cf11 | 662 | |
terencez | 0:f9d13e09cf11 | 663 | typedef void (*lwm2m_transaction_callback_t) (lwm2m_transaction_t * transacP, void * message); |
terencez | 0:f9d13e09cf11 | 664 | |
terencez | 0:f9d13e09cf11 | 665 | struct _lwm2m_transaction_ |
terencez | 0:f9d13e09cf11 | 666 | { |
terencez | 0:f9d13e09cf11 | 667 | lwm2m_transaction_t * next; // matches lwm2m_list_t::next |
terencez | 0:f9d13e09cf11 | 668 | uint16_t mID; // matches lwm2m_list_t::id |
terence zhang | 3:a280069151ac | 669 | void * peerH; |
terence zhang | 3:a280069151ac | 670 | uint8_t ack_received; // indicates, that the ACK was received |
terence zhang | 3:a280069151ac | 671 | time_t response_timeout; // timeout to wait for response, if token is used. When 0, use calculated acknowledge timeout. |
terencez | 0:f9d13e09cf11 | 672 | uint8_t retrans_counter; |
terencez | 0:f9d13e09cf11 | 673 | time_t retrans_time; |
terencez | 0:f9d13e09cf11 | 674 | char objStringID[LWM2M_STRING_ID_MAX_LEN]; |
terencez | 0:f9d13e09cf11 | 675 | char instanceStringID[LWM2M_STRING_ID_MAX_LEN]; |
terencez | 0:f9d13e09cf11 | 676 | char resourceStringID[LWM2M_STRING_ID_MAX_LEN]; |
terencez | 0:f9d13e09cf11 | 677 | void * message; |
terencez | 0:f9d13e09cf11 | 678 | uint16_t buffer_len; |
terencez | 0:f9d13e09cf11 | 679 | uint8_t * buffer; |
terencez | 0:f9d13e09cf11 | 680 | lwm2m_transaction_callback_t callback; |
terencez | 0:f9d13e09cf11 | 681 | void * userData; |
terencez | 0:f9d13e09cf11 | 682 | }; |
terencez | 0:f9d13e09cf11 | 683 | |
terencez | 0:f9d13e09cf11 | 684 | /* |
terencez | 0:f9d13e09cf11 | 685 | * LWM2M observed resources |
terencez | 0:f9d13e09cf11 | 686 | */ |
terencez | 0:f9d13e09cf11 | 687 | typedef struct _lwm2m_watcher_ |
terencez | 0:f9d13e09cf11 | 688 | { |
terencez | 0:f9d13e09cf11 | 689 | struct _lwm2m_watcher_ * next; |
terencez | 0:f9d13e09cf11 | 690 | |
terence zhang | 3:a280069151ac | 691 | bool active; |
terence zhang | 3:a280069151ac | 692 | bool update; |
terencez | 0:f9d13e09cf11 | 693 | lwm2m_server_t * server; |
terence zhang | 3:a280069151ac | 694 | lwm2m_attributes_t * parameters; |
terencez | 0:f9d13e09cf11 | 695 | uint8_t token[8]; |
terencez | 0:f9d13e09cf11 | 696 | size_t tokenLen; |
terence zhang | 3:a280069151ac | 697 | time_t lastTime; |
terencez | 0:f9d13e09cf11 | 698 | uint32_t counter; |
terencez | 0:f9d13e09cf11 | 699 | uint16_t lastMid; |
terence zhang | 3:a280069151ac | 700 | union |
terence zhang | 3:a280069151ac | 701 | { |
terence zhang | 3:a280069151ac | 702 | int64_t asInteger; |
terence zhang | 3:a280069151ac | 703 | double asFloat; |
terence zhang | 3:a280069151ac | 704 | } lastValue; |
terencez | 0:f9d13e09cf11 | 705 | } lwm2m_watcher_t; |
terencez | 0:f9d13e09cf11 | 706 | |
terencez | 0:f9d13e09cf11 | 707 | typedef struct _lwm2m_observed_ |
terencez | 0:f9d13e09cf11 | 708 | { |
terencez | 0:f9d13e09cf11 | 709 | struct _lwm2m_observed_ * next; |
terencez | 0:f9d13e09cf11 | 710 | |
terencez | 0:f9d13e09cf11 | 711 | lwm2m_uri_t uri; |
terencez | 0:f9d13e09cf11 | 712 | lwm2m_watcher_t * watcherList; |
terencez | 0:f9d13e09cf11 | 713 | } lwm2m_observed_t; |
terencez | 0:f9d13e09cf11 | 714 | |
terence zhang | 3:a280069151ac | 715 | #ifdef LWM2M_CLIENT_MODE |
terencez | 0:f9d13e09cf11 | 716 | |
terence zhang | 3:a280069151ac | 717 | typedef enum |
terence zhang | 3:a280069151ac | 718 | { |
terence zhang | 3:a280069151ac | 719 | STATE_INITIAL = 0, |
terence zhang | 3:a280069151ac | 720 | STATE_BOOTSTRAP_REQUIRED, |
terence zhang | 3:a280069151ac | 721 | STATE_BOOTSTRAPPING, |
terence zhang | 3:a280069151ac | 722 | STATE_REGISTER_REQUIRED, |
terence zhang | 3:a280069151ac | 723 | STATE_REGISTERING, |
terence zhang | 3:a280069151ac | 724 | STATE_READY |
terence zhang | 3:a280069151ac | 725 | } lwm2m_client_state_t; |
terence zhang | 3:a280069151ac | 726 | |
terence zhang | 3:a280069151ac | 727 | #endif |
terencez | 0:f9d13e09cf11 | 728 | /* |
terencez | 0:f9d13e09cf11 | 729 | * LWM2M Context |
terencez | 0:f9d13e09cf11 | 730 | */ |
terencez | 0:f9d13e09cf11 | 731 | |
terence zhang | 3:a280069151ac | 732 | #ifdef LWM2M_BOOTSTRAP_SERVER_MODE |
terence zhang | 3:a280069151ac | 733 | // In all the following APIs, the session handle MUST uniquely identify a peer. |
terencez | 0:f9d13e09cf11 | 734 | |
terence zhang | 3:a280069151ac | 735 | // LWM2M bootstrap callback |
terence zhang | 3:a280069151ac | 736 | // When a LWM2M client requests bootstrap information, the callback is called with status COAP_NO_ERROR, uriP is nil and |
terence zhang | 3:a280069151ac | 737 | // name is set. The callback must return a COAP_* error code. COAP_204_CHANGED for success. |
terence zhang | 3:a280069151ac | 738 | // After a lwm2m_bootstrap_delete() or a lwm2m_bootstrap_write(), the callback is called with the status returned by the |
terence zhang | 3:a280069151ac | 739 | // client, the URI of the operation (may be nil) and name is nil. The callback return value is ignored. |
terence zhang | 3:a280069151ac | 740 | typedef int (*lwm2m_bootstrap_callback_t) (void * sessionH, uint8_t status, lwm2m_uri_t * uriP, char * name, void * userData); |
terence zhang | 3:a280069151ac | 741 | #endif |
terencez | 0:f9d13e09cf11 | 742 | |
terencez | 0:f9d13e09cf11 | 743 | typedef struct |
terencez | 0:f9d13e09cf11 | 744 | { |
terencez | 0:f9d13e09cf11 | 745 | #ifdef LWM2M_CLIENT_MODE |
terence zhang | 3:a280069151ac | 746 | lwm2m_client_state_t state; |
terence zhang | 3:a280069151ac | 747 | char * endpointName; |
terence zhang | 3:a280069151ac | 748 | char * msisdn; |
terence zhang | 3:a280069151ac | 749 | char * altPath; |
terence zhang | 3:a280069151ac | 750 | lwm2m_server_t * bootstrapServerList; |
terence zhang | 3:a280069151ac | 751 | lwm2m_server_t * serverList; |
terence zhang | 3:a280069151ac | 752 | lwm2m_object_t * objectList; |
terence zhang | 3:a280069151ac | 753 | lwm2m_observed_t * observedList; |
terencez | 0:f9d13e09cf11 | 754 | #endif |
terencez | 0:f9d13e09cf11 | 755 | #ifdef LWM2M_SERVER_MODE |
terencez | 0:f9d13e09cf11 | 756 | lwm2m_client_t * clientList; |
terencez | 0:f9d13e09cf11 | 757 | lwm2m_result_callback_t monitorCallback; |
terencez | 0:f9d13e09cf11 | 758 | void * monitorUserData; |
terencez | 0:f9d13e09cf11 | 759 | #endif |
terence zhang | 3:a280069151ac | 760 | #ifdef LWM2M_BOOTSTRAP_SERVER_MODE |
terence zhang | 3:a280069151ac | 761 | lwm2m_bootstrap_callback_t bootstrapCallback; |
terence zhang | 3:a280069151ac | 762 | void * bootstrapUserData; |
terence zhang | 3:a280069151ac | 763 | #endif |
terence zhang | 3:a280069151ac | 764 | uint16_t nextMID; |
terence zhang | 3:a280069151ac | 765 | lwm2m_transaction_t * transactionList; |
terence zhang | 3:a280069151ac | 766 | void * userData; |
terencez | 0:f9d13e09cf11 | 767 | } lwm2m_context_t; |
terencez | 0:f9d13e09cf11 | 768 | |
terencez | 14:ec9e195830ff | 769 | #ifdef MBED_OS_EXAMPLE_WAKAAMA |
terencez | 14:ec9e195830ff | 770 | int lwm2m_add_server(lwm2m_context_t * contextP, uint16_t shortID, uint32_t lifetime, char * sms, lwm2m_binding_t binding, void * sessionH, lwm2m_security_t * securityP); |
terencez | 16:31c387e94b6d | 771 | |
terencez | 16:31c387e94b6d | 772 | #if 0 |
terencez | 16:31c387e94b6d | 773 | |
terencez | 16:31c387e94b6d | 774 | /* |
terencez | 16:31c387e94b6d | 775 | * TLV |
terencez | 16:31c387e94b6d | 776 | */ |
terencez | 16:31c387e94b6d | 777 | |
terencez | 16:31c387e94b6d | 778 | #define LWM2M_TLV_HEADER_MAX_LENGTH 6 |
terencez | 16:31c387e94b6d | 779 | |
terencez | 16:31c387e94b6d | 780 | /* |
terencez | 16:31c387e94b6d | 781 | * Bitmask for the lwm2m_tlv_t::flag |
terencez | 16:31c387e94b6d | 782 | * LWM2M_TLV_FLAG_STATIC_DATA specifies that lwm2m_tlv_t::value |
terencez | 16:31c387e94b6d | 783 | * points to static memory and must no be freeed by the caller. |
terencez | 16:31c387e94b6d | 784 | * LWM2M_TLV_FLAG_TEXT_FORMAT specifies that lwm2m_tlv_t::value |
terencez | 16:31c387e94b6d | 785 | * is expressed or requested in plain text format. |
terencez | 16:31c387e94b6d | 786 | */ |
terencez | 16:31c387e94b6d | 787 | #define LWM2M_TLV_FLAG_STATIC_DATA 0x01 |
terencez | 16:31c387e94b6d | 788 | #define LWM2M_TLV_FLAG_TEXT_FORMAT 0x02 |
terencez | 16:31c387e94b6d | 789 | |
terencez | 16:31c387e94b6d | 790 | #ifdef LWM2M_BOOTSTRAP |
terencez | 16:31c387e94b6d | 791 | #define LWM2M_TLV_FLAG_BOOTSTRAPPING 0x04 |
terencez | 16:31c387e94b6d | 792 | #endif |
terencez | 16:31c387e94b6d | 793 | |
terencez | 16:31c387e94b6d | 794 | /* |
terencez | 16:31c387e94b6d | 795 | * Bits 7 and 6 of assigned values for LWM2M_TYPE_RESOURCE, |
terencez | 16:31c387e94b6d | 796 | * LWM2M_TYPE_MULTIPLE_RESOURCE, LWM2M_TYPE_RESOURCE_INSTANCE |
terencez | 16:31c387e94b6d | 797 | * and LWM2M_TYPE_OBJECT_INSTANCE must match the ones defined |
terencez | 16:31c387e94b6d | 798 | * in the TLV format from LWM2M TS §6.3.3 |
terencez | 16:31c387e94b6d | 799 | * |
terencez | 16:31c387e94b6d | 800 | */ |
terencez | 16:31c387e94b6d | 801 | /* |
terencez | 16:31c387e94b6d | 802 | typedef enum |
terencez | 16:31c387e94b6d | 803 | { |
terencez | 16:31c387e94b6d | 804 | LWM2M_TYPE_RESOURCE = 0xC0, |
terencez | 16:31c387e94b6d | 805 | LWM2M_TYPE_MULTIPLE_RESOURCE = 0x80, |
terencez | 16:31c387e94b6d | 806 | LWM2M_TYPE_RESOURCE_INSTANCE = 0x40, |
terencez | 16:31c387e94b6d | 807 | LWM2M_TYPE_OBJECT_INSTANCE = 0x00 |
terencez | 16:31c387e94b6d | 808 | } lwm2m_tlv_type_t; |
terencez | 16:31c387e94b6d | 809 | */ |
terencez | 16:31c387e94b6d | 810 | typedef struct |
terencez | 16:31c387e94b6d | 811 | { |
terencez | 16:31c387e94b6d | 812 | uint8_t flags; |
terencez | 16:31c387e94b6d | 813 | lwm2m_tlv_type_t type; |
terencez | 16:31c387e94b6d | 814 | lwm2m_data_type_t dataType; |
terencez | 16:31c387e94b6d | 815 | uint16_t id; |
terencez | 16:31c387e94b6d | 816 | size_t length; |
terencez | 16:31c387e94b6d | 817 | uint8_t * value; |
terencez | 16:31c387e94b6d | 818 | } lwm2m_tlv_t; |
terencez | 16:31c387e94b6d | 819 | |
terencez | 16:31c387e94b6d | 820 | lwm2m_tlv_t * lwm2m_tlv_new(int size); |
terencez | 16:31c387e94b6d | 821 | int lwm2m_tlv_parse(uint8_t * buffer, size_t bufferLen, lwm2m_tlv_t ** dataP); |
terencez | 16:31c387e94b6d | 822 | int lwm2m_tlv_serialize(int size, lwm2m_tlv_t * tlvP, uint8_t ** bufferP); |
terencez | 16:31c387e94b6d | 823 | void lwm2m_tlv_free(int size, lwm2m_tlv_t * tlvP); |
terencez | 16:31c387e94b6d | 824 | |
terencez | 16:31c387e94b6d | 825 | void lwm2m_tlv_encode_int(int64_t data, lwm2m_tlv_t * tlvP); |
terencez | 16:31c387e94b6d | 826 | int lwm2m_tlv_decode_int(lwm2m_tlv_t * tlvP, int64_t * dataP); |
terencez | 16:31c387e94b6d | 827 | void lwm2m_tlv_encode_float(double data, lwm2m_tlv_t * tlvP); |
terencez | 16:31c387e94b6d | 828 | int lwm2m_tlv_decode_float(lwm2m_tlv_t * tlvP, double * dataP); |
terencez | 16:31c387e94b6d | 829 | void lwm2m_tlv_encode_bool(bool data, lwm2m_tlv_t * tlvP); |
terencez | 16:31c387e94b6d | 830 | int lwm2m_tlv_decode_bool(lwm2m_tlv_t * tlvP, bool * dataP); |
terencez | 16:31c387e94b6d | 831 | void lwm2m_tlv_include(lwm2m_tlv_t * subTlvP, size_t count, lwm2m_tlv_t * tlvP); |
terencez | 16:31c387e94b6d | 832 | #endif |
terencez | 14:ec9e195830ff | 833 | #endif |
terencez | 0:f9d13e09cf11 | 834 | |
terence zhang | 3:a280069151ac | 835 | // initialize a liblwm2m context. |
terence zhang | 3:a280069151ac | 836 | lwm2m_context_t * lwm2m_init(void * userData); |
terencez | 0:f9d13e09cf11 | 837 | // close a liblwm2m context. |
terencez | 0:f9d13e09cf11 | 838 | void lwm2m_close(lwm2m_context_t * contextP); |
terencez | 0:f9d13e09cf11 | 839 | |
terence zhang | 3:a280069151ac | 840 | // perform any required pending operation and adjust timeoutP to the maximal time interval to wait in seconds. |
terence zhang | 3:a280069151ac | 841 | int lwm2m_step(lwm2m_context_t * contextP, time_t * timeoutP); |
terencez | 0:f9d13e09cf11 | 842 | // dispatch received data to liblwm2m |
terencez | 0:f9d13e09cf11 | 843 | void lwm2m_handle_packet(lwm2m_context_t * contextP, uint8_t * buffer, int length, void * fromSessionH); |
terencez | 0:f9d13e09cf11 | 844 | |
terencez | 0:f9d13e09cf11 | 845 | #ifdef LWM2M_CLIENT_MODE |
terence zhang | 3:a280069151ac | 846 | // configure the client side with the Endpoint Name, binding, MSISDN (can be nil), alternative path |
terence zhang | 3:a280069151ac | 847 | // for objects (can be nil) and a list of objects. |
terence zhang | 3:a280069151ac | 848 | // LWM2M Security Object (ID 0) must be present with either a bootstrap server or a LWM2M server and |
terence zhang | 3:a280069151ac | 849 | // its matching LWM2M Server Object (ID 1) instance |
terence zhang | 3:a280069151ac | 850 | int lwm2m_configure(lwm2m_context_t * contextP, const char * endpointName, const char * msisdn, const char * altPath, uint16_t numObject, lwm2m_object_t * objectList[]); |
terence zhang | 3:a280069151ac | 851 | int lwm2m_add_object(lwm2m_context_t * contextP, lwm2m_object_t * objectP); |
terence zhang | 3:a280069151ac | 852 | int lwm2m_remove_object(lwm2m_context_t * contextP, uint16_t id); |
terencez | 0:f9d13e09cf11 | 853 | |
terencez | 0:f9d13e09cf11 | 854 | // send a registration update to the server specified by the server short identifier |
terence zhang | 3:a280069151ac | 855 | // or all if the ID is 0. |
terence zhang | 3:a280069151ac | 856 | // If withObjects is true, the registration update contains the object list. |
terence zhang | 3:a280069151ac | 857 | int lwm2m_update_registration(lwm2m_context_t * contextP, uint16_t shortServerID, bool withObjects); |
terencez | 0:f9d13e09cf11 | 858 | |
terencez | 0:f9d13e09cf11 | 859 | void lwm2m_resource_value_changed(lwm2m_context_t * contextP, lwm2m_uri_t * uriP); |
terencez | 0:f9d13e09cf11 | 860 | #endif |
terencez | 0:f9d13e09cf11 | 861 | |
terencez | 0:f9d13e09cf11 | 862 | #ifdef LWM2M_SERVER_MODE |
terencez | 0:f9d13e09cf11 | 863 | // Clients registration/deregistration monitoring API. |
terence zhang | 3:a280069151ac | 864 | // When a LWM2M client registers, the callback is called with status COAP_201_CREATED. |
terence zhang | 3:a280069151ac | 865 | // When a LWM2M client deregisters, the callback is called with status COAP_202_DELETED. |
terencez | 0:f9d13e09cf11 | 866 | // clientID is the internal ID of the LWM2M Client. |
terencez | 0:f9d13e09cf11 | 867 | // The callback's parameters uri, data, dataLength are always NULL. |
terencez | 0:f9d13e09cf11 | 868 | // The lwm2m_client_t is present in the lwm2m_context_t's clientList when the callback is called. On a deregistration, it deleted when the callback returns. |
terencez | 0:f9d13e09cf11 | 869 | void lwm2m_set_monitoring_callback(lwm2m_context_t * contextP, lwm2m_result_callback_t callback, void * userData); |
terencez | 0:f9d13e09cf11 | 870 | |
terencez | 0:f9d13e09cf11 | 871 | // Device Management APIs |
terencez | 0:f9d13e09cf11 | 872 | int lwm2m_dm_read(lwm2m_context_t * contextP, uint16_t clientID, lwm2m_uri_t * uriP, lwm2m_result_callback_t callback, void * userData); |
terence zhang | 3:a280069151ac | 873 | int lwm2m_dm_discover(lwm2m_context_t * contextP, uint16_t clientID, lwm2m_uri_t * uriP, lwm2m_result_callback_t callback, void * userData); |
terence zhang | 3:a280069151ac | 874 | int lwm2m_dm_write(lwm2m_context_t * contextP, uint16_t clientID, lwm2m_uri_t * uriP, lwm2m_media_type_t format, uint8_t * buffer, int length, lwm2m_result_callback_t callback, void * userData); |
terence zhang | 3:a280069151ac | 875 | int lwm2m_dm_write_attributes(lwm2m_context_t * contextP, uint16_t clientID, lwm2m_uri_t * uriP, lwm2m_attributes_t * attrP, lwm2m_result_callback_t callback, void * userData); |
terence zhang | 3:a280069151ac | 876 | int lwm2m_dm_execute(lwm2m_context_t * contextP, uint16_t clientID, lwm2m_uri_t * uriP, lwm2m_media_type_t format, uint8_t * buffer, int length, lwm2m_result_callback_t callback, void * userData); |
terence zhang | 3:a280069151ac | 877 | int lwm2m_dm_create(lwm2m_context_t * contextP, uint16_t clientID, lwm2m_uri_t * uriP, lwm2m_media_type_t format, uint8_t * buffer, int length, lwm2m_result_callback_t callback, void * userData); |
terencez | 0:f9d13e09cf11 | 878 | int lwm2m_dm_delete(lwm2m_context_t * contextP, uint16_t clientID, lwm2m_uri_t * uriP, lwm2m_result_callback_t callback, void * userData); |
terencez | 0:f9d13e09cf11 | 879 | |
terencez | 0:f9d13e09cf11 | 880 | // Information Reporting APIs |
terencez | 0:f9d13e09cf11 | 881 | int lwm2m_observe(lwm2m_context_t * contextP, uint16_t clientID, lwm2m_uri_t * uriP, lwm2m_result_callback_t callback, void * userData); |
terencez | 0:f9d13e09cf11 | 882 | int lwm2m_observe_cancel(lwm2m_context_t * contextP, uint16_t clientID, lwm2m_uri_t * uriP, lwm2m_result_callback_t callback, void * userData); |
terencez | 0:f9d13e09cf11 | 883 | #endif |
terencez | 0:f9d13e09cf11 | 884 | |
terence zhang | 3:a280069151ac | 885 | #ifdef LWM2M_BOOTSTRAP_SERVER_MODE |
terence zhang | 3:a280069151ac | 886 | // Clients bootstrap request monitoring API. |
terence zhang | 3:a280069151ac | 887 | // When a LWM2M client sends a bootstrap request, the callback is called with the client's endpoint name. |
terence zhang | 3:a280069151ac | 888 | void lwm2m_set_bootstrap_callback(lwm2m_context_t * contextP, lwm2m_bootstrap_callback_t callback, void * userData); |
terence zhang | 3:a280069151ac | 889 | |
terence zhang | 3:a280069151ac | 890 | // Boostrap Interface APIs |
terence zhang | 3:a280069151ac | 891 | // if uriP is nil, a "Delete /" is sent to the client |
terence zhang | 3:a280069151ac | 892 | int lwm2m_bootstrap_delete(lwm2m_context_t * contextP, void * sessionH, lwm2m_uri_t * uriP); |
terence zhang | 3:a280069151ac | 893 | int lwm2m_bootstrap_write(lwm2m_context_t * contextP, void * sessionH, lwm2m_uri_t * uriP, lwm2m_media_type_t format, uint8_t * buffer, size_t length); |
terence zhang | 3:a280069151ac | 894 | int lwm2m_bootstrap_finish(lwm2m_context_t * contextP, void * sessionH); |
terence zhang | 3:a280069151ac | 895 | |
terencez | 0:f9d13e09cf11 | 896 | #endif |
terence zhang | 3:a280069151ac | 897 | |
terence zhang | 3:a280069151ac | 898 | #ifdef __cplusplus |
terence zhang | 3:a280069151ac | 899 | } |
terence zhang | 3:a280069151ac | 900 | #endif |
terence zhang | 3:a280069151ac | 901 | |
terence zhang | 3:a280069151ac | 902 | #endif |