Core Base Classes for the Light Endpoints
Dependents: mbed_mqtt_endpoint_ublox_ethernet mbed_mqtt_endpoint_ublox_cellular mbed_nsp_endpoint_ublox_cellular mbed_nsp_endpoint_ublox_ethernet ... more
CommonDefinitions.h@176:3c86e0cf7e21, 2014-08-29 (annotated)
- Committer:
- ansond
- Date:
- Fri Aug 29 03:41:01 2014 +0000
- Revision:
- 176:3c86e0cf7e21
- Parent:
- 175:d17460899bc9
- Child:
- 178:670bd170f3eb
updates
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
ansond | 38:825f8e834e77 | 1 | /* Copyright C2013 Doug Anson, MIT License |
ansond | 38:825f8e834e77 | 2 | * |
ansond | 38:825f8e834e77 | 3 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
ansond | 38:825f8e834e77 | 4 | * and associated documentation files the "Software", to deal in the Software without restriction, |
ansond | 38:825f8e834e77 | 5 | * including without limitation the rights to use, copy, modify, merge, publish, distribute, |
ansond | 38:825f8e834e77 | 6 | * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is |
ansond | 38:825f8e834e77 | 7 | * furnished to do so, subject to the following conditions: |
ansond | 38:825f8e834e77 | 8 | * |
ansond | 38:825f8e834e77 | 9 | * The above copyright notice and this permission notice shall be included in all copies or |
ansond | 38:825f8e834e77 | 10 | * substantial portions of the Software. |
ansond | 38:825f8e834e77 | 11 | * |
ansond | 38:825f8e834e77 | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
ansond | 38:825f8e834e77 | 13 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
ansond | 38:825f8e834e77 | 14 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
ansond | 38:825f8e834e77 | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
ansond | 38:825f8e834e77 | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
ansond | 38:825f8e834e77 | 17 | */ |
ansond | 38:825f8e834e77 | 18 | |
ansond | 38:825f8e834e77 | 19 | #ifndef _COMMON_DEFINITIONS_H_ |
ansond | 38:825f8e834e77 | 20 | #define _COMMON_DEFINITIONS_H_ |
ansond | 38:825f8e834e77 | 21 | |
ansond | 38:825f8e834e77 | 22 | // Error Handler Log Message Length |
ansond | 134:58e7537a8c5f | 23 | #define MAX_LOG_MESSAGE 900 // maximum size of a logging message |
ansond | 134:58e7537a8c5f | 24 | #define TEMP_BUFFER_LEN 128 // working/temp buffer length |
ansond | 38:825f8e834e77 | 25 | |
ansond | 38:825f8e834e77 | 26 | // Resource Configuration |
ansond | 134:58e7537a8c5f | 27 | #define RESOURCE_NAME_LEN 25 // Resource name max length |
ansond | 134:58e7537a8c5f | 28 | #define RESOURCE_VALUE_LEN 33 // Resource value max length |
ansond | 38:825f8e834e77 | 29 | |
ansond | 38:825f8e834e77 | 30 | // Number of Resources our Endpoint has |
ansond | 155:582462821bd7 | 31 | #define NUM_RESOURCES 30 // do not exceed this number of resources in the endpoint. currently at 25 |
ansond | 85:8af3f3101ba3 | 32 | |
ansond | 85:8af3f3101ba3 | 33 | // IOC <--> Resource Mapping |
ansond | 155:582462821bd7 | 34 | #define NUM_MAPPINGS 20 // do not exceed this number of IOC <--> NSP resource mappings. currently at 17 |
ansond | 38:825f8e834e77 | 35 | |
ansond | 38:825f8e834e77 | 36 | // MapEntry Name length |
ansond | 93:ac4a8d3c2a4f | 37 | #define MAX_NAME_LENGTH 25 |
ansond | 38:825f8e834e77 | 38 | |
ansond | 112:1fb53d4729af | 39 | // Preferences configuration |
ansond | 155:582462821bd7 | 40 | #define MAX_NUM_PREFERENCES 5 // support a total of 5 unique preferences |
ansond | 155:582462821bd7 | 41 | #define PREFERENCE_NAME_LEN 24 // largest preference name |
ansond | 155:582462821bd7 | 42 | #define PREFERENCE_VALUE_LEN 40 // largest preference value |
ansond | 134:58e7537a8c5f | 43 | |
ansond | 134:58e7537a8c5f | 44 | // Personality Configuration |
ansond | 134:58e7537a8c5f | 45 | #define NUM_PERSONALITY_INSTANCES 1 // number of isntances of a specific personality (i.e. light) in this endpoint |
ansond | 134:58e7537a8c5f | 46 | #define PERSONALITY_NAME_LEN 48 // buffer size for the personality name |
ansond | 134:58e7537a8c5f | 47 | #define PERSONALITY_NAME_INDEX 1 // start index for the ID of the personality name |
ansond | 112:1fb53d4729af | 48 | |
ansond | 38:825f8e834e77 | 49 | // Common Light Definition |
ansond | 171:3f07e1df766c | 50 | #define LIGHT_DIM_STATE "75" // initial dimming state of each light in this endpoint |
ansond | 134:58e7537a8c5f | 51 | #define LIGHT_TYPE_STRING "Light" // Type of Light (string) |
ansond | 134:58e7537a8c5f | 52 | #define LIGHT_BLINK_WAIT_MS 1000 // time between blinks (ms) |
ansond | 140:df0ca2c95982 | 53 | #define LIGHT_DEFAULT_STATE 1 // ON by default |
ansond | 140:df0ca2c95982 | 54 | |
ansond | 158:0cecb265bb18 | 55 | // Multitech probe for temperature reporting |
ansond | 158:0cecb265bb18 | 56 | //#define MULTITECH_TEMP_PROBE true |
ansond | 158:0cecb265bb18 | 57 | |
ansond | 140:df0ca2c95982 | 58 | // Personalities may have unique default light states |
ansond | 140:df0ca2c95982 | 59 | #ifdef LIGHT_PERSONALITY |
ansond | 140:df0ca2c95982 | 60 | #undef LIGHT_DEFAULT_STATE |
ansond | 140:df0ca2c95982 | 61 | #undef LIGHT_BLINK_WAIT_MS |
ansond | 141:26dca377597f | 62 | #define LIGHT_DEFAULT_STATE "1" // ON by default |
ansond | 140:df0ca2c95982 | 63 | #define LIGHT_BLINK_WAIT_MS 1000 // time between blinks (ms) |
ansond | 167:2529c18d0eb1 | 64 | #if APM_LIGHT_ENABLE |
ansond | 167:2529c18d0eb1 | 65 | #define APM_LIGHT_PERSONALITY true |
ansond | 167:2529c18d0eb1 | 66 | #endif |
ansond | 140:df0ca2c95982 | 67 | #endif |
ansond | 140:df0ca2c95982 | 68 | #ifdef COPCAR_PERSONALITY |
ansond | 140:df0ca2c95982 | 69 | #undef LIGHT_DEFAULT_STATE |
ansond | 140:df0ca2c95982 | 70 | #undef LIGHT_BLINK_WAIT_MS |
ansond | 141:26dca377597f | 71 | #define LIGHT_DEFAULT_STATE "0" // OFF by default |
ansond | 140:df0ca2c95982 | 72 | #define LIGHT_BLINK_WAIT_MS 400 // time between blinks (ms) |
ansond | 140:df0ca2c95982 | 73 | #endif |
ansond | 38:825f8e834e77 | 74 | |
ansond | 38:825f8e834e77 | 75 | // Main Loop |
ansond | 134:58e7537a8c5f | 76 | #define MAIN_LOOP_SLEEP 250 // sleep time (ms) between main loop iterations |
ansond | 38:825f8e834e77 | 77 | |
ansond | 38:825f8e834e77 | 78 | // LED Blink Time |
ansond | 134:58e7537a8c5f | 79 | #define BLINK_TIME 100 // LED blink times |
ansond | 38:825f8e834e77 | 80 | |
ansond | 134:58e7537a8c5f | 81 | // External Linkage Resource |
ansond | 134:58e7537a8c5f | 82 | #define EXTERNAL_LINKAGE_RESOURCE "/dev/addldata" // resource containing IOC linkage ID |
ansond | 134:58e7537a8c5f | 83 | #define EXTERNAL_LINKAGE_UNSET "id:0" // IOC linkage not set |
ansond | 114:bd38ad417d6a | 84 | |
ansond | 174:e8f11d1b5e3f | 85 | // Salesforce Case generation (Status Report) |
ansond | 176:3c86e0cf7e21 | 86 | #define SF_STATUS_REPORTING true // true - enable, false - disable |
ansond | 174:e8f11d1b5e3f | 87 | |
ansond | 175:d17460899bc9 | 88 | // ----------------- Status Reporting TUNABLES ----------------- |
ansond | 175:d17460899bc9 | 89 | |
ansond | 175:d17460899bc9 | 90 | // Tunables for RFID tags |
ansond | 175:d17460899bc9 | 91 | #define FIRST_WIDGET_RFID 9909120 |
ansond | 175:d17460899bc9 | 92 | #define FIRST_WIDGET_NAME "Tech 49" |
ansond | 175:d17460899bc9 | 93 | #define FIRST_WIDGET_DESCRIPTION "Investigating Issue" |
ansond | 175:d17460899bc9 | 94 | #define SECOND_WIDGET_RFID 9909121 |
ansond | 175:d17460899bc9 | 95 | #define SECOND_WIDGET_NAME "Tech 49" |
ansond | 175:d17460899bc9 | 96 | #define SECOND_WIDGET_DESCRIPTION "Issue Resolved" |
ansond | 175:d17460899bc9 | 97 | #define THIRD_WIDGET_RFID 9909122 |
ansond | 175:d17460899bc9 | 98 | #define THIRD_WIDGET_NAME "Tech 49" |
ansond | 175:d17460899bc9 | 99 | #define THIRD_WIDGET_DESCRIPTION "Issue Escalation" |
ansond | 175:d17460899bc9 | 100 | |
ansond | 175:d17460899bc9 | 101 | // ----------------- Status Reporting TUNABLES ----------------- |
ansond | 175:d17460899bc9 | 102 | |
ansond | 175:d17460899bc9 | 103 | // DF2014 CaseGenerator Relay for mbed - ties into the Salesforce APEX host for case generation |
ansond | 175:d17460899bc9 | 104 | #define DF_CASE_GEN_URL "https://df2014-arm-developer-edition.na15.force.com/services/apexrest/CaseService" |
ansond | 174:e8f11d1b5e3f | 105 | |
ansond | 175:d17460899bc9 | 106 | // Buffer length for HTTPS requests |
ansond | 175:d17460899bc9 | 107 | #define BUFFER_LENGTH 256 |
ansond | 175:d17460899bc9 | 108 | |
ansond | 175:d17460899bc9 | 109 | // Tunables for WidgetDB |
ansond | 175:d17460899bc9 | 110 | #define DB_MAX_NAME_LENGTH 64 |
ansond | 175:d17460899bc9 | 111 | #define DB_MAX_DESCRIPTION_LENGTH 128 |
ansond | 175:d17460899bc9 | 112 | #define DB_MAX_NUM_WIDGETS 3 |
ansond | 175:d17460899bc9 | 113 | |
ansond | 175:d17460899bc9 | 114 | // convenience definitions for WidgetDB... 2 RFIDs/station |
ansond | 175:d17460899bc9 | 115 | #define FIRST_WIDGET 0 |
ansond | 175:d17460899bc9 | 116 | #define SECOND_WIDGET 1 |
ansond | 175:d17460899bc9 | 117 | #define THIRD_WIDGET 2 |
ansond | 174:e8f11d1b5e3f | 118 | |
ansond | 38:825f8e834e77 | 119 | // Philips Light Support |
ansond | 38:825f8e834e77 | 120 | #define PL_LIGHT_ID_DOUG 1 // Dougs Light |
ansond | 38:825f8e834e77 | 121 | #define PL_LIGHT_ID_BILL 2 // Bills Light |
ansond | 38:825f8e834e77 | 122 | #define PL_LIGHT_ID_KERRY 3 // Kerrys Light |
ansond | 134:58e7537a8c5f | 123 | #define PL_GW_ADDRESS "192.168.1.178" // Philips Gateway in IOT lab (Austin) |
ansond | 90:0fed8d3e0b81 | 124 | #define PL_DEFAULT_STATE LIGHT_DEFAULT_STATE // on |
ansond | 38:825f8e834e77 | 125 | #define PL_DEFAULT_DIM 11 // dim value |
ansond | 38:825f8e834e77 | 126 | #define PL_URL_BUFFER_LEN 128 |
ansond | 38:825f8e834e77 | 127 | #define PL_PAYLOAD_BUFFER_LEN 128 |
ansond | 38:825f8e834e77 | 128 | #define PL_RESPONSE_BUFFER_LEN 128 |
ansond | 38:825f8e834e77 | 129 | #define PL_URL_TEMPLATE "http://%s/api/newdeveloper/lights/%d/state" |
ansond | 97:d631edbc157b | 130 | #define PL_ON_COMMAND_TEMPLATE "{ \"on\":%s, \"sat\":211, \"bri\":%d, \"hue\":13122 } " |
ansond | 38:825f8e834e77 | 131 | |
ansond | 160:24337c83dd1d | 132 | #ifndef CELLULAR_NETWORK |
ansond | 161:a85cb6cba5ed | 133 | // Error Handler - use mutexes? |
ansond | 161:a85cb6cba5ed | 134 | #define EH_USE_MUTEXES true // true - yes, undef - no |
ansond | 161:a85cb6cba5ed | 135 | |
ansond | 161:a85cb6cba5ed | 136 | // Network - use mutexes? |
ansond | 161:a85cb6cba5ed | 137 | #define NETWORK_MUTEX true // true - yes, undef - no |
ansond | 161:a85cb6cba5ed | 138 | |
ansond | 161:a85cb6cba5ed | 139 | // Has Threads? |
ansond | 161:a85cb6cba5ed | 140 | #define ENABLE_THREADS true // true - yes, undef - no |
ansond | 160:24337c83dd1d | 141 | #endif |
ansond | 160:24337c83dd1d | 142 | |
ansond | 128:fde8d042a9af | 143 | // Platform specific customizations |
ansond | 127:58cd1d28f734 | 144 | #ifdef _ENDPOINT_UBLOX_PLATFORM |
ansond | 128:fde8d042a9af | 145 | #define PLATFORM_STRING "U-Blox MBED" // platform string |
ansond | 136:f433e40f8d65 | 146 | #define EXT_LED_PIN D3 // pin to use for external LED cathode, use D6 for speaker |
ansond | 145:24ac7ac92777 | 147 | #define EXT_LED_PIN_COPCAR D10 // pin to use for external LED cathode (copcar personality only) |
ansond | 130:630d05daed77 | 148 | #define BATTERY_POT_PIN A0 // pin for the battery POT |
ansond | 130:630d05daed77 | 149 | #define VOLTAGE_POT_PIN A1 // pin for the voltage POT |
ansond | 130:630d05daed77 | 150 | #define TEMP_SENSOR_PIN1 P0_0 // pin for temp sensor |
ansond | 130:630d05daed77 | 151 | #define TEMP_SENSOR_PIN2 P0_1 // pin for temp sensor |
ansond | 127:58cd1d28f734 | 152 | #endif |
ansond | 127:58cd1d28f734 | 153 | |
ansond | 127:58cd1d28f734 | 154 | #ifdef _ENDPOINT_NXP_PLATFORM |
ansond | 128:fde8d042a9af | 155 | #define PLATFORM_STRING "NXP MBED" // platform string |
ansond | 128:fde8d042a9af | 156 | #define EXT_LED_PIN p21 // pin to use for external LED cathode |
ansond | 143:1388cb37c27e | 157 | #define EXT_LED_PIN_COPCAR p22 // pin to use for external LED cathode (copcar personality only) |
ansond | 128:fde8d042a9af | 158 | #define BATTERY_POT_PIN p20 // pin for the battery POT |
ansond | 128:fde8d042a9af | 159 | #define VOLTAGE_POT_PIN p19 // pin for the voltage POT |
ansond | 128:fde8d042a9af | 160 | #define TEMP_SENSOR_PIN1 p28 // pin for temp sensor |
ansond | 128:fde8d042a9af | 161 | #define TEMP_SENSOR_PIN2 p27 // pin for temp sensor |
ansond | 127:58cd1d28f734 | 162 | #endif |
ansond | 127:58cd1d28f734 | 163 | |
ansond | 128:fde8d042a9af | 164 | #ifdef _ENDPOINT_FREEDOM_PLATFORM |
ansond | 128:fde8d042a9af | 165 | #define PLATFORM_STRING "Freescale MBED" // platform string |
ansond | 128:fde8d042a9af | 166 | #define EXT_LED_PIN p21 // pin to use for external LED cathode |
ansond | 143:1388cb37c27e | 167 | #define EXT_LED_PIN_COPCAR p22 // pin to use for external LED cathode (copcar personality only) |
ansond | 128:fde8d042a9af | 168 | #define BATTERY_POT_PIN p20 // pin for the battery POT |
ansond | 128:fde8d042a9af | 169 | #define VOLTAGE_POT_PIN p19 // pin for the voltage POT |
ansond | 128:fde8d042a9af | 170 | #define TEMP_SENSOR_PIN1 p28 // pin for temp sensor |
ansond | 128:fde8d042a9af | 171 | #define TEMP_SENSOR_PIN2 p27 // pin for temp sensor |
ansond | 127:58cd1d28f734 | 172 | #endif |
ansond | 127:58cd1d28f734 | 173 | |
ansond | 38:825f8e834e77 | 174 | #endif // _COMMON_DEFINITIONS_H_ |