Doug Anson / mbedConnectorInterfaceWithDM

mbed Connector Interface simplification API on top of mbed-client

Fork of mbedConnectorInterfaceV3 by Doug Anson

NOTE:

This repo has been replaced with https://github.com/ARMmbed/mbedConnectorInterface. No further updates will occur with this repo. Please use the github repo instead. Thanks!

mbed-connector-interface/Options.h@0:1f1f55e73248, 2016-02-19 (annotated)

Committer:
ansond
Date:
Fri Feb 19 17:32:14 2016 +0000
Revision:
0:1f1f55e73248
Child:
8:f950fb1b78c0
initial checkin

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ansond 0:1f1f55e73248 1 /**
ansond 0:1f1f55e73248 2 * @file Options.h
ansond 0:1f1f55e73248 3 * @brief mbed CoAP Options (immutable OptionsBuilder instance) class header
ansond 0:1f1f55e73248 4 * @author Doug Anson/Chris Paola
ansond 0:1f1f55e73248 5 * @version 1.0
ansond 0:1f1f55e73248 6 * @see
ansond 0:1f1f55e73248 7 *
ansond 0:1f1f55e73248 8 * Copyright (c) 2014
ansond 0:1f1f55e73248 9 *
ansond 0:1f1f55e73248 10 * Licensed under the Apache License, Version 2.0 (the "License");
ansond 0:1f1f55e73248 11 * you may not use this file except in compliance with the License.
ansond 0:1f1f55e73248 12 * You may obtain a copy of the License at
ansond 0:1f1f55e73248 13 *
ansond 0:1f1f55e73248 14 * http://www.apache.org/licenses/LICENSE-2.0
ansond 0:1f1f55e73248 15 *
ansond 0:1f1f55e73248 16 * Unless required by applicable law or agreed to in writing, software
ansond 0:1f1f55e73248 17 * distributed under the License is distributed on an "AS IS" BASIS,
ansond 0:1f1f55e73248 18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ansond 0:1f1f55e73248 19 * See the License for the specific language governing permissions and
ansond 0:1f1f55e73248 20 * limitations under the License.
ansond 0:1f1f55e73248 21 */
ansond 0:1f1f55e73248 22
ansond 0:1f1f55e73248 23 #ifndef __OPTIONS_H__
ansond 0:1f1f55e73248 24 #define __OPTIONS_H__
ansond 0:1f1f55e73248 25
ansond 0:1f1f55e73248 26 // Device Resources
ansond 0:1f1f55e73248 27 #include "mbed-connector-interface/DeviceResource.h"
ansond 0:1f1f55e73248 28
ansond 0:1f1f55e73248 29 // Static Resources
ansond 0:1f1f55e73248 30 #include "mbed-connector-interface/StaticResource.h"
ansond 0:1f1f55e73248 31
ansond 0:1f1f55e73248 32 // Dynamic Resources
ansond 0:1f1f55e73248 33 #include "mbed-connector-interface/DynamicResource.h"
ansond 0:1f1f55e73248 34
ansond 0:1f1f55e73248 35 // include the mbed connector resource list
ansond 0:1f1f55e73248 36 #include "mbed-connector-interface/mbedConnectorInterface.h"
ansond 0:1f1f55e73248 37
ansond 0:1f1f55e73248 38 // include the resource observer includes here so that they are not required in main.cpp
ansond 0:1f1f55e73248 39 #include "mbed-connector-interface/ThreadedResourceObserver.h"
ansond 0:1f1f55e73248 40 #include "mbed-connector-interface/TickerResourceObserver.h"
ansond 0:1f1f55e73248 41
ansond 0:1f1f55e73248 42 // Vector support
ansond 0:1f1f55e73248 43 #include <vector>
ansond 0:1f1f55e73248 44
ansond 0:1f1f55e73248 45 // Resources list
ansond 0:1f1f55e73248 46 typedef vector<DeviceResource *> DeviceResourcesList;
ansond 0:1f1f55e73248 47 typedef vector<StaticResource *> StaticResourcesList;
ansond 0:1f1f55e73248 48 typedef vector<DynamicResource *> DynamicResourcesList;
ansond 0:1f1f55e73248 49 typedef vector<ResourceObserver *> ResourceObserversList;
ansond 0:1f1f55e73248 50
ansond 0:1f1f55e73248 51 // WiFi Security types
ansond 0:1f1f55e73248 52 typedef enum {
ansond 0:1f1f55e73248 53 WIFI_WPA_PERSONAL,
ansond 0:1f1f55e73248 54 WIFI_WPA2_PERSONAL,
ansond 0:1f1f55e73248 55 WIFI_WEP,
ansond 0:1f1f55e73248 56 WIFI_NUM_TYPES
ansond 0:1f1f55e73248 57 } WiFiAuthTypes;
ansond 0:1f1f55e73248 58
ansond 0:1f1f55e73248 59 namespace Connector {
ansond 0:1f1f55e73248 60
ansond 0:1f1f55e73248 61 /** Options class
ansond 0:1f1f55e73248 62 */
ansond 0:1f1f55e73248 63 class Options
ansond 0:1f1f55e73248 64 {
ansond 0:1f1f55e73248 65 public:
ansond 0:1f1f55e73248 66 /**
ansond 0:1f1f55e73248 67 Default constructor
ansond 0:1f1f55e73248 68 */
ansond 0:1f1f55e73248 69 Options();
ansond 0:1f1f55e73248 70
ansond 0:1f1f55e73248 71 /**
ansond 0:1f1f55e73248 72 Copy constructor
ansond 0:1f1f55e73248 73 */
ansond 0:1f1f55e73248 74 Options(const Options &opt);
ansond 0:1f1f55e73248 75
ansond 0:1f1f55e73248 76 /**
ansond 0:1f1f55e73248 77 Destructor
ansond 0:1f1f55e73248 78 */
ansond 0:1f1f55e73248 79 virtual ~Options();
ansond 0:1f1f55e73248 80
ansond 0:1f1f55e73248 81 /**
ansond 0:1f1f55e73248 82 Get the node lifetime
ansond 0:1f1f55e73248 83 */
ansond 0:1f1f55e73248 84 int getLifetime();
ansond 0:1f1f55e73248 85
ansond 0:1f1f55e73248 86 /**
ansond 0:1f1f55e73248 87 Get the NSP domain
ansond 0:1f1f55e73248 88 */
ansond 0:1f1f55e73248 89 string getDomain();
ansond 0:1f1f55e73248 90
ansond 0:1f1f55e73248 91 /**
ansond 0:1f1f55e73248 92 Get the node name
ansond 0:1f1f55e73248 93 */
ansond 0:1f1f55e73248 94 string getEndpointNodename();
ansond 0:1f1f55e73248 95
ansond 0:1f1f55e73248 96 /**
ansond 0:1f1f55e73248 97 Get the node type
ansond 0:1f1f55e73248 98 */
ansond 0:1f1f55e73248 99 string getEndpointType();
ansond 0:1f1f55e73248 100
ansond 0:1f1f55e73248 101 /**
ansond 0:1f1f55e73248 102 Get the node radio channel list
ansond 0:1f1f55e73248 103 */
ansond 0:1f1f55e73248 104 uint32_t getRadioChannelList();
ansond 0:1f1f55e73248 105
ansond 0:1f1f55e73248 106 /**
ansond 0:1f1f55e73248 107 Get the mbed registration update period
ansond 0:1f1f55e73248 108 */
ansond 0:1f1f55e73248 109 int getRegUpdatePeriod();
ansond 0:1f1f55e73248 110
ansond 0:1f1f55e73248 111 /**
ansond 0:1f1f55e73248 112 Get the endpoint Connector URL
ansond 0:1f1f55e73248 113 */
ansond 0:1f1f55e73248 114 char *getConnectorURL();
ansond 0:1f1f55e73248 115
ansond 0:1f1f55e73248 116 /**
ansond 0:1f1f55e73248 117 Get the node MAC address
ansond 0:1f1f55e73248 118 */
ansond 0:1f1f55e73248 119 uint8_t *getMACAddress();
ansond 0:1f1f55e73248 120
ansond 0:1f1f55e73248 121 /**
ansond 0:1f1f55e73248 122 Get the list of device resources
ansond 0:1f1f55e73248 123 */
ansond 0:1f1f55e73248 124 DeviceResourcesList *getDeviceResourceList();
ansond 0:1f1f55e73248 125
ansond 0:1f1f55e73248 126 /**
ansond 0:1f1f55e73248 127 Get the list of static resources
ansond 0:1f1f55e73248 128 */
ansond 0:1f1f55e73248 129 StaticResourcesList *getStaticResourceList();
ansond 0:1f1f55e73248 130
ansond 0:1f1f55e73248 131 /**
ansond 0:1f1f55e73248 132 Get the list of dynamic resources
ansond 0:1f1f55e73248 133 */
ansond 0:1f1f55e73248 134 DynamicResourcesList *getDynamicResourceList();
ansond 0:1f1f55e73248 135
ansond 0:1f1f55e73248 136 /**
ansond 0:1f1f55e73248 137 Get the WiFi SSID
ansond 0:1f1f55e73248 138 */
ansond 0:1f1f55e73248 139 string getWiFiSSID();
ansond 0:1f1f55e73248 140
ansond 0:1f1f55e73248 141 /**
ansond 0:1f1f55e73248 142 Get the WiFi Auth Type
ansond 0:1f1f55e73248 143 */
ansond 0:1f1f55e73248 144 WiFiAuthTypes getWiFiAuthType();
ansond 0:1f1f55e73248 145
ansond 0:1f1f55e73248 146 /**
ansond 0:1f1f55e73248 147 Get the WiFi Auth Key
ansond 0:1f1f55e73248 148 */
ansond 0:1f1f55e73248 149 string getWiFiAuthKey();
ansond 0:1f1f55e73248 150
ansond 0:1f1f55e73248 151 /**
ansond 0:1f1f55e73248 152 Get the 802.15.4 Network ID
ansond 0:1f1f55e73248 153 */
ansond 0:1f1f55e73248 154 string getNetworkID();
ansond 0:1f1f55e73248 155
ansond 0:1f1f55e73248 156 /**
ansond 0:1f1f55e73248 157 Get the 802.15.4 Radio channel
ansond 0:1f1f55e73248 158 */
ansond 0:1f1f55e73248 159 uint8_t getRadioChannel();
ansond 0:1f1f55e73248 160
ansond 0:1f1f55e73248 161 /**
ansond 0:1f1f55e73248 162 Enable/Disable Immediate Observationing
ansond 0:1f1f55e73248 163 */
ansond 0:1f1f55e73248 164 bool immedateObservationEnabled();
ansond 0:1f1f55e73248 165
ansond 0:1f1f55e73248 166 /**
ansond 0:1f1f55e73248 167 Enable/Disable Observation control via GET
ansond 0:1f1f55e73248 168 */
ansond 0:1f1f55e73248 169 bool enableGETObservationControl();
ansond 0:1f1f55e73248 170
ansond 0:1f1f55e73248 171 /**
ansond 0:1f1f55e73248 172 Get the Server Certificate
ansond 0:1f1f55e73248 173 */
ansond 0:1f1f55e73248 174 uint8_t *getServerCertificate();
ansond 0:1f1f55e73248 175
ansond 0:1f1f55e73248 176 /**
ansond 0:1f1f55e73248 177 Get the Server Certificate Size (bytes)
ansond 0:1f1f55e73248 178 */
ansond 0:1f1f55e73248 179 int getServerCertificateSize();
ansond 0:1f1f55e73248 180
ansond 0:1f1f55e73248 181 /**
ansond 0:1f1f55e73248 182 Get the Client Certificate
ansond 0:1f1f55e73248 183 */
ansond 0:1f1f55e73248 184 uint8_t *getClientCertificate();
ansond 0:1f1f55e73248 185
ansond 0:1f1f55e73248 186 /**
ansond 0:1f1f55e73248 187 Get the Client Certificate Size (bytes)
ansond 0:1f1f55e73248 188 */
ansond 0:1f1f55e73248 189 int getClientCertificateSize();
ansond 0:1f1f55e73248 190
ansond 0:1f1f55e73248 191 /**
ansond 0:1f1f55e73248 192 Get the Client Key
ansond 0:1f1f55e73248 193 */
ansond 0:1f1f55e73248 194 uint8_t *getClientKey();
ansond 0:1f1f55e73248 195
ansond 0:1f1f55e73248 196 /**
ansond 0:1f1f55e73248 197 Get the Client Key Size (bytes)
ansond 0:1f1f55e73248 198 */
ansond 0:1f1f55e73248 199 int getClientKeySize();
ansond 0:1f1f55e73248 200
ansond 0:1f1f55e73248 201 protected:
ansond 0:1f1f55e73248 202 // mDS Resources
ansond 0:1f1f55e73248 203 int m_lifetime;
ansond 0:1f1f55e73248 204 string m_domain;
ansond 0:1f1f55e73248 205 string m_node_name;
ansond 0:1f1f55e73248 206 string m_endpoint_type;
ansond 0:1f1f55e73248 207 int m_reg_update_period;
ansond 0:1f1f55e73248 208 string m_connector_url;
ansond 0:1f1f55e73248 209
ansond 0:1f1f55e73248 210 // WiFi Resources
ansond 0:1f1f55e73248 211 string m_wifi_ssid;
ansond 0:1f1f55e73248 212 string m_wifi_auth_key;
ansond 0:1f1f55e73248 213 WiFiAuthTypes m_wifi_auth_type;
ansond 0:1f1f55e73248 214
ansond 0:1f1f55e73248 215 // 802.15.4 Resources
ansond 0:1f1f55e73248 216 string m_network_id;
ansond 0:1f1f55e73248 217 uint32_t m_channel_list;
ansond 0:1f1f55e73248 218 uint8_t m_mac_address[NODE_MAC_ADDRESS_LENGTH];
ansond 0:1f1f55e73248 219 uint8_t m_channel;
ansond 0:1f1f55e73248 220
ansond 0:1f1f55e73248 221 // DTLS/TLS Resources
ansond 0:1f1f55e73248 222 uint8_t m_server_cert[MAX_SERVER_CERT_LENGTH];
ansond 0:1f1f55e73248 223 int m_server_cert_length;
ansond 0:1f1f55e73248 224 uint8_t m_client_cert[MAX_CLIENT_CERT_LENGTH];
ansond 0:1f1f55e73248 225 int m_client_cert_length;
ansond 0:1f1f55e73248 226 uint8_t m_client_key[MAX_CLIENT_KEY_LENGTH];
ansond 0:1f1f55e73248 227 int m_client_key_length;
ansond 0:1f1f55e73248 228
ansond 0:1f1f55e73248 229 // CoAP behavior adjustments
ansond 0:1f1f55e73248 230 bool m_enable_immediate_observation;
ansond 0:1f1f55e73248 231 bool m_enable_get_obs_control;
ansond 0:1f1f55e73248 232
ansond 0:1f1f55e73248 233 // Endpoint Resources
ansond 0:1f1f55e73248 234 DeviceResourcesList m_device_resources;
ansond 0:1f1f55e73248 235 StaticResourcesList m_static_resources;
ansond 0:1f1f55e73248 236 DynamicResourcesList m_dynamic_resources;
ansond 0:1f1f55e73248 237 ResourceObserversList m_resource_observers;
ansond 0:1f1f55e73248 238 };
ansond 0:1f1f55e73248 239
ansond 0:1f1f55e73248 240 } // namespace Connector
ansond 0:1f1f55e73248 241
ansond 0:1f1f55e73248 242 #endif // __OPTIONS_H__
ansond 0:1f1f55e73248 243