├── README.md ├── DebugHelpers.h ├── .gitignore ├── ScannerDisplay.h ├── ScannerDisplay.cpp ├── Handheld-WiFi-Scanner-ESP8266.ino └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # Handheld-WiFi-Scanner-ESP8266 2 | Handheld WiFi Scanner based on ESP8266 3 | -------------------------------------------------------------------------------- /DebugHelpers.h: -------------------------------------------------------------------------------- 1 | #ifdef DEBUG 2 | #define DEBUG_LOG(text) Serial.print(text) 3 | #define DEBUG_LOG_LN(text) Serial.println(text) 4 | #else 5 | #define DEBUG_LOG(text) 6 | #define DEBUG_LOG_LN(text) 7 | #endif 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Prerequisites 2 | *.d 3 | 4 | # Compiled Object files 5 | *.slo 6 | *.lo 7 | *.o 8 | *.obj 9 | 10 | # Precompiled Headers 11 | *.gch 12 | *.pch 13 | 14 | # Compiled Dynamic libraries 15 | *.so 16 | *.dylib 17 | *.dll 18 | 19 | # Fortran module files 20 | *.mod 21 | *.smod 22 | 23 | # Compiled Static libraries 24 | *.lai 25 | *.la 26 | *.a 27 | *.lib 28 | 29 | # Executables 30 | *.exe 31 | *.out 32 | *.app 33 | -------------------------------------------------------------------------------- /ScannerDisplay.h: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | #ifdef U8X8_HAVE_HW_SPI 4 | #include 5 | #endif 6 | #ifdef U8X8_HAVE_HW_I2C 7 | #include 8 | #endif 9 | 10 | #define WEATHER_DISPLAY_W 128 11 | #define WEATHER_DISPLAY_H 64 12 | 13 | #define NA 0 14 | 15 | class CScannerDisplay 16 | { 17 | public: 18 | 19 | struct SScanInfoDisplay 20 | { 21 | String m_ssid = "N/A"; 22 | uint8_t m_encryptionType = NA; 23 | int32_t m_rssi = NA; 24 | String m_bssid = "N/A"; 25 | int32_t m_channel = NA; 26 | bool m_isHidden = false; 27 | 28 | uint8_t m_currentAp; 29 | uint8_t m_totalAp; 30 | }; 31 | 32 | CScannerDisplay(); 33 | void Init(); 34 | 35 | void ScanAnimation(); 36 | void ToMonitorModeTransition(); 37 | void DisplayScanListInfo(SScanInfoDisplay& scanInfo); 38 | void DisplayMonitorInfo(SScanInfoDisplay& scanInfo); 39 | void DisplayError(const char* error); 40 | 41 | void ResetAnimations(); 42 | 43 | private: 44 | void DrawSignalStrengthBar(int rssi, int x_lt, int y_lt, int x_rb, int y_rb); 45 | String EncryptionTypeToString(short encType); 46 | int dBmtoPercentage(int dBm); 47 | 48 | int m_animtaionCounter = 0; 49 | unsigned long m_animationTime = 350; 50 | unsigned long m_prevAnimationTime = 0; 51 | 52 | }; 53 | -------------------------------------------------------------------------------- /ScannerDisplay.cpp: -------------------------------------------------------------------------------- 1 | #include "ScannerDisplay.h" 2 | 3 | U8G2_SH1106_128X64_NONAME_F_HW_I2C u8g2(U8G2_R0, /* reset=*/ U8X8_PIN_NONE); 4 | 5 | CScannerDisplay::CScannerDisplay() 6 | { 7 | } 8 | 9 | void CScannerDisplay::Init() 10 | { 11 | u8g2.begin(); 12 | u8g2.setContrast(255); 13 | u8g2.clearBuffer(); 14 | u8g2.setDrawColor(1); 15 | u8g2.setFont(u8g2_font_5x7_tr); 16 | u8g2.sendBuffer(); 17 | } 18 | 19 | void CScannerDisplay::DisplayScanListInfo(SScanInfoDisplay& scanInfo) 20 | { 21 | uint8_t offsetY = 0; 22 | uint8_t offsetX = 0; 23 | u8g2.clearBuffer(); 24 | u8g2.drawFrame(offsetX, offsetY, WEATHER_DISPLAY_W, WEATHER_DISPLAY_H); 25 | 26 | u8g2.setFont(u8g2_font_7x13B_tr); 27 | uint8_t fontHeight = u8g2.getMaxCharHeight(); 28 | uint8_t fontWidth = u8g2.getMaxCharWidth(); 29 | 30 | offsetX += 5; 31 | offsetY += 1 + fontHeight; 32 | u8g2.drawStr(offsetX, offsetY, scanInfo.m_ssid.c_str()); 33 | 34 | offsetY += fontHeight + 2; 35 | 36 | u8g2.drawStr(offsetX, offsetY, scanInfo.m_bssid.c_str()); 37 | 38 | u8g2.setFont(u8g2_font_tinytim_tf); 39 | fontHeight = u8g2.getMaxCharHeight(); 40 | fontWidth = u8g2.getMaxCharWidth(); 41 | 42 | offsetY += fontHeight + 5; 43 | 44 | u8g2.drawStr(offsetX, offsetY, (String("SGN: ") + String(scanInfo.m_rssi)).c_str()); 45 | offsetY += fontHeight + 2; 46 | u8g2.drawStr(offsetX, offsetY, (String("CHN: ") + String(scanInfo.m_channel)).c_str()); 47 | offsetY += fontHeight + 2; 48 | u8g2.drawStr(offsetX, offsetY, (String("ENC: ") + EncryptionTypeToString(scanInfo.m_encryptionType)).c_str()); 49 | offsetY += fontHeight + 2; 50 | u8g2.drawStr(offsetX, offsetY, scanInfo.m_isHidden ? "<>" : ""); // Where it should go? 51 | 52 | offsetY -= fontHeight + 2; 53 | 54 | u8g2.setFont(u8g2_font_courB08_tn); 55 | String pageOutOf = String(scanInfo.m_currentAp) + '/' + String(scanInfo.m_totalAp); 56 | offsetX = u8g2.getDisplayWidth() - u8g2.getStrWidth((String(scanInfo.m_totalAp) + '/' + String(scanInfo.m_totalAp)).c_str()) - 5; 57 | u8g2.drawStr(offsetX, offsetY, pageOutOf.c_str()); 58 | 59 | u8g2.drawFrame(offsetX - 6, offsetY - u8g2.getMaxCharHeight()- 3, WEATHER_DISPLAY_W, WEATHER_DISPLAY_H); 60 | 61 | u8g2.setFont(u8g2_font_open_iconic_arrow_2x_t); 62 | if(scanInfo.m_currentAp != scanInfo.m_totalAp) 63 | { 64 | u8g2.drawStr(offsetX - 5 - 20, offsetY + 5, "\x4F"); 65 | } 66 | 67 | if(scanInfo.m_currentAp != 1) 68 | { 69 | u8g2.drawStr(offsetX - 6 - 35, offsetY + 5, "\x4C"); 70 | } 71 | 72 | 73 | u8g2.sendBuffer(); 74 | } 75 | 76 | 77 | void CScannerDisplay::ScanAnimation() 78 | { 79 | unsigned long currentTime = millis(); 80 | if(currentTime - m_prevAnimationTime > m_animationTime) 81 | { 82 | m_prevAnimationTime = currentTime; 83 | 84 | const short offsetX = 10; 85 | const short mutliplier = 2; 86 | 87 | u8g2.clearBuffer(); 88 | for(int i = 0; i < 3; ++i) 89 | { 90 | u8g2.drawDisc(offsetX + 30 + 25 * i, WEATHER_DISPLAY_H/2 - 7, 5 * (m_animtaionCounter == i ? mutliplier : 1)); 91 | } 92 | 93 | m_animtaionCounter = ++m_animtaionCounter % 3; 94 | 95 | u8g2.setFont(u8g2_font_7x13B_tr); 96 | const char* message = "Scanning"; 97 | u8g2.drawStr(WEATHER_DISPLAY_W/2 - u8g2.getStrWidth(message)/2, 55, message); 98 | u8g2.sendBuffer(); 99 | } 100 | } 101 | 102 | void CScannerDisplay::ToMonitorModeTransition() 103 | { 104 | unsigned long currentTime = millis(); 105 | if(currentTime - m_prevAnimationTime > m_animationTime) 106 | { 107 | m_prevAnimationTime = currentTime; 108 | 109 | const short offsetX = 10; 110 | const short mutliplier = 2; 111 | 112 | u8g2.clearBuffer(); 113 | 114 | u8g2.drawDisc(offsetX + 30, WEATHER_DISPLAY_H/2 - 7, 5 * (m_animtaionCounter == 0 ? mutliplier : 1)); 115 | u8g2.drawDisc(offsetX + 55, WEATHER_DISPLAY_H/2 - 7, 5 * (m_animtaionCounter == 1 ? mutliplier : 1)); 116 | u8g2.drawDisc(offsetX + 80, WEATHER_DISPLAY_H/2 - 7, 5 * (m_animtaionCounter == 0 ? mutliplier : 1)); 117 | 118 | m_animtaionCounter = ++m_animtaionCounter % 2; 119 | 120 | u8g2.setFont(u8g2_font_7x13B_tr); 121 | const char* message = "Monitor Mode"; 122 | u8g2.drawStr(WEATHER_DISPLAY_W/2 - u8g2.getStrWidth(message)/2, 55, message); 123 | u8g2.sendBuffer(); 124 | } 125 | } 126 | 127 | void CScannerDisplay::DisplayMonitorInfo(SScanInfoDisplay& scanInfo) 128 | { 129 | uint8_t offsetY = 0; 130 | uint8_t offsetX = 0; 131 | u8g2.clearBuffer(); 132 | u8g2.drawFrame(offsetX, offsetY, WEATHER_DISPLAY_W, WEATHER_DISPLAY_H); 133 | 134 | u8g2.setFont(u8g2_font_inb27_mr); 135 | uint8_t fontHeight = u8g2.getMaxCharHeight(); 136 | uint8_t fontWidth = u8g2.getMaxCharWidth(); 137 | 138 | if(scanInfo.m_rssi == NA) 139 | { 140 | offsetX += floor(WEATHER_DISPLAY_W/2) - fontWidth -10; 141 | offsetY += fontHeight - 5; 142 | 143 | u8g2.drawStr(offsetX, offsetY, "N/A"); 144 | } 145 | else 146 | { 147 | offsetX += floor(WEATHER_DISPLAY_W/2) - 2*fontWidth; 148 | offsetY += fontHeight - 5; 149 | 150 | u8g2.drawStr(offsetX, offsetY, String(scanInfo.m_rssi).c_str()); 151 | } 152 | 153 | u8g2.setFont(u8g2_font_7x13B_tr); 154 | fontHeight = u8g2.getMaxCharHeight(); 155 | fontWidth = u8g2.getMaxCharWidth(); 156 | 157 | offsetX = 5; 158 | offsetY = WEATHER_DISPLAY_H - 7 - fontHeight; 159 | u8g2.drawStr(offsetX, offsetY, scanInfo.m_ssid.c_str()); 160 | 161 | offsetY += fontHeight + 2; 162 | 163 | u8g2.drawStr(offsetX, offsetY, scanInfo.m_bssid.c_str()); 164 | 165 | DrawSignalStrengthBar(scanInfo.m_rssi, 5, 5, 12, 25); 166 | DrawSignalStrengthBar(scanInfo.m_rssi, WEATHER_DISPLAY_W - 5 - 12, 5, 12, 25); 167 | 168 | u8g2.sendBuffer(); 169 | } 170 | 171 | void CScannerDisplay::DrawSignalStrengthBar(int rssi, int x, int y, int width, int height) 172 | { 173 | int percents = dBmtoPercentage(rssi); 174 | 175 | u8g2.drawHLine(x, y, width); 176 | u8g2.drawHLine(x, y + height, width); 177 | 178 | if(rssi != NA && height > 0) 179 | { 180 | int barHeight = floor((height / 100.f) * percents); 181 | u8g2.drawBox(x, y + height - barHeight, width, barHeight); 182 | } 183 | } 184 | 185 | void CScannerDisplay::DisplayError(const char* error) 186 | { 187 | u8g2.clearBuffer(); 188 | u8g2.setFont(u8g2_font_7x13B_tr); 189 | u8g2.drawStr(16, 63, error); 190 | u8g2.sendBuffer(); 191 | } 192 | 193 | String CScannerDisplay::EncryptionTypeToString(short encType) 194 | { 195 | switch(encType) 196 | { 197 | case 5: 198 | return "WEP"; 199 | case 2: 200 | return "TKIP"; 201 | case 4: 202 | return "CCMP"; 203 | case 7: 204 | return "NONE"; 205 | case 8: 206 | return "AUTO"; 207 | default: 208 | return "FAIL"; 209 | } 210 | } 211 | 212 | int CScannerDisplay::dBmtoPercentage(int dBm) 213 | { 214 | const int RSSI_MAX =-50;// define maximum strength of signal in dBm 215 | const int RSSI_MIN =-100;// define minimum strength of signal in dBm 216 | 217 | int quality; 218 | if(dBm <= RSSI_MIN) 219 | { 220 | quality = 0; 221 | } 222 | else if(dBm >= RSSI_MAX) 223 | { 224 | quality = 100; 225 | } 226 | else 227 | { 228 | quality = 2 * (dBm + 100); 229 | } 230 | 231 | return quality; 232 | } 233 | -------------------------------------------------------------------------------- /Handheld-WiFi-Scanner-ESP8266.ino: -------------------------------------------------------------------------------- 1 | #include "ESP8266WiFi.h" 2 | #include "AwesomeClickButton.h" 3 | #include "ScannerDisplay.h" 4 | #include "DebugHelpers.h" 5 | 6 | enum EContext 7 | { 8 | INVALID = -1, 9 | ERROR = 0, 10 | SCAN_ANIMATION, 11 | MONITOR_ANIMATION, 12 | SCAN_PAGE , 13 | MONITOR_PAGE 14 | } g_context = INVALID; 15 | 16 | #define SCAN_BUTTON_PIN D10 17 | #define SELECT_BUTTON_PIN D2 18 | 19 | CScannerDisplay scannerDisplay; 20 | 21 | bool pageChanged = true; 22 | int g_totalAp = 0; 23 | int g_currentNetworkIndex = 0; 24 | 25 | bool g_apLocked = false; 26 | String g_bssid; 27 | String g_ssid; 28 | 29 | bool IsAnyAPLocked() 30 | { 31 | return g_apLocked; 32 | } 33 | 34 | void LockAP() 35 | { 36 | g_bssid = WiFi.BSSIDstr(g_currentNetworkIndex); 37 | g_ssid = WiFi.SSID(g_currentNetworkIndex); 38 | g_apLocked = true; 39 | } 40 | 41 | void UnlockAP() 42 | { 43 | g_apLocked = false; 44 | } 45 | 46 | bool FindLockedAP(int& foundAPIndex) 47 | { 48 | if(IsAnyAPLocked()) 49 | { 50 | for(int i = 0; i < g_totalAp; ++i) 51 | { 52 | if(strcmp(g_bssid.c_str(), WiFi.BSSIDstr(i).c_str()) == 0) 53 | { 54 | foundAPIndex = i; 55 | return true; 56 | } 57 | } 58 | } 59 | return false; 60 | } 61 | 62 | AwesomeClickButton scanButton(SCAN_BUTTON_PIN); 63 | void onScanButtonClicked() 64 | { 65 | DEBUG_LOG_LN(F("Scan Button Click")); 66 | 67 | if(g_context != EContext::SCAN_PAGE) 68 | { 69 | return; 70 | } 71 | 72 | g_currentNetworkIndex = --g_currentNetworkIndex < 0 ? g_totalAp - 1 : g_currentNetworkIndex; 73 | pageChanged = true; 74 | 75 | DEBUG_LOG(F("Scan Button Processing Index: ")); 76 | DEBUG_LOG_LN(g_currentNetworkIndex); 77 | } 78 | 79 | void onScanLongClickListener(int duration) 80 | { 81 | DEBUG_LOG_LN(F("Scan Button Long Click")); 82 | 83 | if(g_context < EContext::SCAN_PAGE) 84 | { 85 | return; 86 | } 87 | 88 | DEBUG_LOG_LN(F("Scan Button Long Click Processing")); 89 | 90 | UnlockAP(); 91 | ScanNetworks(); 92 | } 93 | 94 | AwesomeClickButton selectButton(SELECT_BUTTON_PIN); 95 | void onSelectButtonClicked() 96 | { 97 | DEBUG_LOG_LN(F("Select Button Click")); 98 | 99 | if(g_context != EContext::SCAN_PAGE) 100 | { 101 | return; 102 | } 103 | 104 | DEBUG_LOG_LN(F("Select Button Click Processing")); 105 | 106 | g_currentNetworkIndex = ++g_currentNetworkIndex % g_totalAp; 107 | pageChanged = true; 108 | 109 | DEBUG_LOG(F("Select Button Click Processing ")); 110 | DEBUG_LOG_LN(g_currentNetworkIndex); 111 | } 112 | 113 | void onSelectLongClickListener(int duration) 114 | { 115 | DEBUG_LOG_LN(F("Select Button Long Click")); 116 | 117 | if(g_context < EContext::SCAN_PAGE) 118 | { 119 | return; 120 | } 121 | 122 | DEBUG_LOG_LN(F("Select Button Long Click processing")); 123 | 124 | switch(g_context) 125 | { 126 | case SCAN_PAGE: 127 | LockAP(); 128 | MonitorNetwork(); 129 | g_context = EContext::MONITOR_ANIMATION; 130 | break; 131 | case MONITOR_PAGE: 132 | UnlockAP(); 133 | ScanNetworks(); 134 | break; 135 | } 136 | } 137 | 138 | void setup() { 139 | Serial.begin(9600); 140 | 141 | WiFi.mode(WIFI_STA); 142 | WiFi.disconnect(); 143 | 144 | scanButton.setOnClickListener(onScanButtonClicked); 145 | scanButton.setOnLongClickListener(onScanLongClickListener); 146 | scanButton.setSingleClickTime(65); 147 | scanButton.setDebounceTime(25); 148 | 149 | selectButton.setOnClickListener(onSelectButtonClicked); 150 | selectButton.setOnLongClickListener(onSelectLongClickListener); 151 | selectButton.setSingleClickTime(65); 152 | selectButton.setDebounceTime(25); 153 | 154 | scannerDisplay.Init(); 155 | 156 | ScanNetworks(); 157 | } 158 | 159 | void OnScanComplete(int totalAps) 160 | { 161 | g_totalAp = totalAps; 162 | g_currentNetworkIndex = 0; 163 | pageChanged = true; 164 | if(g_totalAp > 0) 165 | { 166 | g_context = EContext::SCAN_PAGE; 167 | } 168 | else 169 | { 170 | DEBUG_LOG_LN(F("No APs found. Scan again.")); 171 | scannerDisplay.DisplayError("No APs found. Scan again."); 172 | g_context = EContext::ERROR; 173 | } 174 | } 175 | 176 | void OnMonScanComplete(int totalAps) 177 | { 178 | DEBUG_LOG_LN(F("DisplayMonitorInfo()")); 179 | 180 | g_totalAp = totalAps; 181 | 182 | if(g_totalAp > 0) 183 | { 184 | CScannerDisplay::SScanInfoDisplay scanInfo; 185 | scanInfo.m_bssid = g_bssid; 186 | scanInfo.m_ssid = g_ssid; 187 | 188 | int foundAp = 0; 189 | if(FindLockedAP(foundAp)) 190 | { 191 | scanInfo.m_currentAp = foundAp; 192 | 193 | uint8_t* bssid_fake; 194 | if(WiFi.getNetworkInfo(scanInfo.m_currentAp, scanInfo.m_ssid, scanInfo.m_encryptionType, scanInfo.m_rssi, bssid_fake, scanInfo.m_channel, scanInfo.m_isHidden)) 195 | { 196 | scannerDisplay.DisplayMonitorInfo(scanInfo); 197 | } 198 | else 199 | { 200 | DEBUG_LOG_LN(F("WiFi.getNetworkInfo() - Failed")); 201 | scanInfo.m_rssi = NA; 202 | scannerDisplay.DisplayMonitorInfo(scanInfo); 203 | } 204 | } 205 | else 206 | { 207 | DEBUG_LOG_LN(F("AP LOST")); 208 | scanInfo.m_rssi = NA; 209 | scannerDisplay.DisplayMonitorInfo(scanInfo); 210 | } 211 | } 212 | else 213 | { 214 | DEBUG_LOG_LN(F("Monitor scan failed")); 215 | scannerDisplay.DisplayError("Monitor scan failed"); 216 | } 217 | 218 | if(g_context == EContext::MONITOR_ANIMATION) 219 | { 220 | g_context = EContext::MONITOR_PAGE; 221 | } 222 | } 223 | 224 | void ScanNetworks() 225 | { 226 | DEBUG_LOG_LN(F("ScanNetworks()")); 227 | 228 | WiFi.scanDelete(); 229 | const bool showHidden = true; 230 | WiFi.scanNetworksAsync(OnScanComplete, showHidden); 231 | 232 | g_context = EContext::SCAN_ANIMATION; 233 | } 234 | 235 | bool MonitorNetwork() 236 | { 237 | if(WiFi.scanComplete() >= 0) 238 | { 239 | DEBUG_LOG_LN(F("MonitorNetwork()")); 240 | 241 | WiFi.scanDelete(); 242 | const bool showHidden = true; 243 | WiFi.scanNetworksAsync(OnMonScanComplete, showHidden); 244 | } 245 | } 246 | 247 | void DisplayScannedAP() 248 | { 249 | if(pageChanged) 250 | { 251 | DEBUG_LOG_LN(F("DisplayScannedAP() - pageChanged")); 252 | pageChanged = false; 253 | 254 | CScannerDisplay::SScanInfoDisplay scanInfo; 255 | scanInfo.m_currentAp = g_currentNetworkIndex + 1; 256 | scanInfo.m_totalAp = g_totalAp; 257 | scanInfo.m_bssid = WiFi.BSSIDstr(scanInfo.m_currentAp); 258 | 259 | uint8_t* bssid_fake; 260 | if(WiFi.getNetworkInfo(g_currentNetworkIndex, scanInfo.m_ssid, scanInfo.m_encryptionType, scanInfo.m_rssi, bssid_fake, scanInfo.m_channel, scanInfo.m_isHidden)) 261 | { 262 | scannerDisplay.DisplayScanListInfo(scanInfo); 263 | } 264 | else 265 | { 266 | DEBUG_LOG_LN(F("FAILED to retrieve scan result info.")); 267 | scannerDisplay.DisplayError("FAILED to retrieve scan result info."); 268 | } 269 | } 270 | } 271 | 272 | void loop() 273 | { 274 | scanButton.update(); 275 | selectButton.update(); 276 | 277 | switch(g_context) 278 | { 279 | case EContext::SCAN_PAGE: 280 | DisplayScannedAP(); 281 | break; 282 | case EContext::MONITOR_PAGE: 283 | MonitorNetwork(); 284 | break; 285 | case EContext::SCAN_ANIMATION: 286 | scannerDisplay.ScanAnimation(); 287 | break; 288 | case EContext::MONITOR_ANIMATION: 289 | scannerDisplay.ToMonitorModeTransition(); 290 | break; 291 | case EContext::ERROR: 292 | break; 293 | default: 294 | break; 295 | } 296 | } 297 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------