Simple interface for Mbed Cloud Client
Embed:
(wiki syntax)
Show/hide line numbers
fcc_defs.h
Go to the documentation of this file.
00001 // ---------------------------------------------------------------------------- 00002 // Copyright 2016-2017 ARM Ltd. 00003 // 00004 // Licensed under the Apache License, Version 2.0 (the "License"); 00005 // you may not use this file except in compliance with the License. 00006 // You may obtain a copy of the License at 00007 // 00008 // http://www.apache.org/licenses/LICENSE-2.0 00009 // 00010 // Unless required by applicable law or agreed to in writing, software 00011 // distributed under the License is distributed on an "AS IS" BASIS, 00012 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00013 // See the License for the specific language governing permissions and 00014 // limitations under the License. 00015 // ---------------------------------------------------------------------------- 00016 00017 #ifndef __FCC_DEFS_H__ 00018 #define __FCC_DEFS_H__ 00019 00020 00021 #ifdef __cplusplus 00022 extern "C" { 00023 #endif 00024 /** 00025 * @file fcc_defs.h 00026 * \brief factory configurator client defines. 00027 * Contains the names of all parameters needed to configure the device to work with mbed Cloud. 00028 */ 00029 /* 00030 * Warnings linked list structure 00031 */ 00032 struct fcc_warning_info_ { 00033 //Example for warning_info_string - "Certificate is self signed:mbed.BootstrapServerCACert" 00034 char *warning_info_string;// pattern of the warning string - warning_string:item_name 00035 struct fcc_warning_info_ *next; 00036 }; 00037 typedef struct fcc_warning_info_ fcc_warning_info_s; 00038 /** 00039 * Output info structure 00040 */ 00041 typedef struct fcc_output_info_ { 00042 //Example for error_string_info - "Invalid certificate:mbed.BootstrapServerCACert" 00043 char *error_string_info; // pattern of the error string - error_string:failed_item_name. Only one error string is possible. 00044 size_t size_of_warning_info_list; // size of warning_info_list 00045 struct fcc_warning_info_ *head_of_warning_list; //The head of warning list 00046 struct fcc_warning_info_ *tail_of_warning_list; //The tail of warning list 00047 } fcc_output_info_s; 00048 /*=== Device general information ===*/ 00049 00050 /** 00051 * Bootstrap mode parameter name. 00052 */ 00053 extern const char g_fcc_use_bootstrap_parameter_name[]; 00054 00055 /** 00056 * Endpoint parameter name. 00057 */ 00058 extern const char g_fcc_endpoint_parameter_name[]; 00059 00060 /** 00061 * First to claim parameter name. 00062 */ 00063 extern const char g_fcc_first_to_claim_parameter_name[]; 00064 00065 /*=== Device meta data ===*/ 00066 00067 /** 00068 * Manufacturer parameter name. 00069 */ 00070 extern const char g_fcc_manufacturer_parameter_name[]; 00071 00072 /** 00073 * Model number parameter name. 00074 */ 00075 extern const char g_fcc_model_number_parameter_name[]; 00076 00077 /** 00078 * Device type parameter name. 00079 */ 00080 extern const char g_fcc_device_type_parameter_name[]; 00081 00082 /** 00083 * Hardware version parameter name. 00084 */ 00085 extern const char g_fcc_hardware_version_parameter_name[]; 00086 00087 /** 00088 * Memory size parameter name. 00089 */ 00090 extern const char g_fcc_memory_size_parameter_name[]; 00091 00092 /** 00093 * Device serial number parameter name. 00094 */ 00095 extern const char g_fcc_device_serial_number_parameter_name[]; 00096 00097 /** 00098 * Device current time parameter name. 00099 */ 00100 extern const char g_fcc_current_time_parameter_name[]; 00101 /** 00102 * Device time zone name. 00103 */ 00104 extern const char g_fcc_device_time_zone_parameter_name[]; 00105 /** 00106 * Offset of the device timezone from UTC name. 00107 */ 00108 extern const char g_fcc_offset_from_utc_parameter_name[]; 00109 00110 /*=== Bootstrap configuration ===*/ 00111 00112 /** 00113 * Bootstrap server CA certificate parameter name. 00114 */ 00115 extern const char g_fcc_bootstrap_server_ca_certificate_name[]; 00116 00117 /** 00118 * Bootstrap server CRL parameter name. 00119 */ 00120 extern const char g_fcc_bootstrap_server_crl_name[]; 00121 00122 /** 00123 * Bootstrap server URI parameter name. 00124 */ 00125 extern const char g_fcc_bootstrap_server_uri_name[]; 00126 00127 /** 00128 * Bootstrap device certificate parameter name. 00129 */ 00130 extern const char g_fcc_bootstrap_device_certificate_name[]; 00131 00132 /** 00133 * Bootstrap device private key parameter name. 00134 */ 00135 extern const char g_fcc_bootstrap_device_private_key_name[]; 00136 00137 /*=== LWM2M configuration ===*/ 00138 00139 /** 00140 * LWM2M server CA certificate parameter name. 00141 */ 00142 extern const char g_fcc_lwm2m_server_ca_certificate_name[]; 00143 00144 /** 00145 * LWM2M server CRL parameter name. 00146 */ 00147 extern const char g_fcc_lwm2m_server_crl_name[]; 00148 00149 /** 00150 * LWM2M server URI parameter name. 00151 */ 00152 extern const char g_fcc_lwm2m_server_uri_name[]; 00153 00154 /** 00155 * LWM2M device certificate parameter name. 00156 */ 00157 extern const char g_fcc_lwm2m_device_certificate_name[]; 00158 00159 /** 00160 * LWM2M device private key parameter name. 00161 */ 00162 extern const char g_fcc_lwm2m_device_private_key_name[]; 00163 00164 /** 00165 * Firmware update authentication certificate parameter name. 00166 */ 00167 extern const char g_fcc_update_authentication_certificate_name[]; 00168 00169 00170 /** 00171 * Firmware update class id name. 00172 */ 00173 extern const char g_fcc_class_id_name[]; 00174 00175 /** 00176 * Firmware update vendor id name. 00177 */ 00178 00179 extern const char g_fcc_vendor_id_name[]; 00180 00181 00182 #ifdef __cplusplus 00183 } 00184 #endif 00185 00186 #endif //__FCC_DEFS_H__
Generated on Tue Jul 12 2022 19:01:34 by 1.7.2