├── Digital_Level_v1.ino ├── LICENSE ├── README.md └── digital_level_diagram.png /Digital_Level_v1.ino: -------------------------------------------------------------------------------- 1 | /* DesignBuildDestroy.com - Digital Level 1.0 2 | Written by DesignBuildDestroy (DBD) 2020 3 | 4 | This program is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | This program is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | 14 | You should have received a copy of the GNU General Public License 15 | along with this program. If not, see . 16 | 17 | Required Libraries 18 | * Jeff Rowberg's MPU6050 library: https://github.com/jrowberg/i2cdevlib/tree/master/Arduino/MPU6050 19 | * Jeff Rowberg's I2Cdev library: https://github.com/jrowberg/i2cdevlib/tree/master/Arduino/I2Cdev 20 | * Adafruit SSD1306 OLED library: https://github.com/adafruit/Adafruit_SSD1306 21 | * Adafruit GFX library: https://github.com/adafruit/Adafruit-GFX-Library 22 | * Adafruit font from GFX library: https://github.com/adafruit/Adafruit-GFX-Library/blob/master/Fonts/FreeMono9pt7b.h 23 | 24 | */ 25 | 26 | #include "I2Cdev.h" 27 | #include "Wire.h" 28 | #include "MPU6050_6Axis_MotionApps20.h" //Must include for DMP holds firmware hex to push to MPU on init 29 | #include 30 | #include 31 | #include 32 | #include //Font for menus only 33 | 34 | 35 | // SSD1306 OLED 36 | const byte SCREEN_WIDTH = 128; // OLED display width, in pixels 37 | const byte SCREEN_HEIGHT = 64; // OLED display height, in pixels 38 | Adafruit_SSD1306 display(SCREEN_WIDTH, SCREEN_HEIGHT, &Wire, -1); 39 | 40 | // Menu & menu button definitions 41 | const byte MENU_BTN = 3; 42 | const byte ENTER_BTN = 4; 43 | unsigned long menuStartTime = 0; //To use with menuTimeout to track if we should auto exit 44 | byte menuItem = 0; //Hold the current menu's item selected 45 | const int menuTimeout = 10000; //Time out value for menus to auto exit 46 | bool precisionMode = false; //Menu option to show 1 decimal places instead of rounding to whole. 47 | 48 | 49 | // MPU Address for I2C 50 | byte devAddr = 0x68; 51 | MPU6050 mpu(devAddr); 52 | 53 | // MPU control/status vars from JRowberg 54 | bool dmpReady = false; // set true if DMP init was successful 55 | byte mpuIntStatus; // holds actual interrupt status byte from MPU 56 | byte devStatus; // return status after each device operation (0 = success, !0 = error) 57 | int packetSize; // expected DMP packet size (default is 42 bytes) 58 | int fifoCount; // count of all bytes currently in FIFO 59 | byte fifoBuffer[64]; // FIFO storage buffer 60 | Quaternion q; // [w, x, y, z] quaternion container 61 | 62 | 63 | // Modified version of Adafruit BN0555 library to convert Quaternion to world angles the way we need 64 | // The math is a little different here compared to Adafruit's version to work the way I needed for this project 65 | VectorFloat QtoEulerAngle(Quaternion qt) { 66 | VectorFloat ret; 67 | double sqw = qt.w * qt.w; 68 | double sqx = qt.x * qt.x; 69 | double sqy = qt.y * qt.y; 70 | double sqz = qt.z * qt.z; 71 | 72 | ret.x = atan2(2.0 * (qt.x * qt.y + qt.z * qt.w), (sqx - sqy - sqz + sqw)); 73 | ret.y = asin(2.0 * (qt.x * qt.z - qt.y * qt.w) / (sqx + sqy + sqz + sqw)); //Adafruit uses -2.0 *.. 74 | ret.z = atan2( 2.0 * (qt.y * qt.z + qt.x * qt.w), (-sqx - sqy + sqz + sqw)); 75 | 76 | // Added to convert Radian to Degrees 77 | ret.x = ret.x * 180 / PI; 78 | ret.y = ret.y * 180 / PI; 79 | ret.z = ret.z * 180 / PI; 80 | return ret; 81 | } 82 | 83 | // Write a 2 byte word starting at the startAddr provided 84 | void epromWriteWord(int startAddr, int value) { 85 | EEPROM.update(startAddr, value); 86 | EEPROM.update(startAddr+1, value >> 8); 87 | } 88 | 89 | // Return a 2 byte word read from a starting EEPROM address 90 | int epromReadWord(int startAddr) { 91 | int value = EEPROM.read(startAddr); 92 | value = value | (EEPROM.read(startAddr+1) << 8); 93 | return value; 94 | } 95 | 96 | void getCalibration() { 97 | // Get the saved calibration values from EEPROM and update MPU 98 | // Address Always starts at 0 ends at 11, 2 bytes per axis 99 | 100 | // Future Check if we have anything saved (look for all FF) 101 | // if not assume calibration not run and skip setting just MPU default 102 | // Eventually prompt user to calibrate! if there's enough space left in memory of this sketch!!! 103 | mpu.setXAccelOffset(epromReadWord(0)); 104 | mpu.setYAccelOffset(epromReadWord(2)); 105 | mpu.setZAccelOffset(epromReadWord(4)); 106 | mpu.setXGyroOffset(epromReadWord(6)); 107 | mpu.setYGyroOffset(epromReadWord(8)); 108 | mpu.setZGyroOffset(epromReadWord(10)); // last address read would be 11 decimal in eeprom 109 | } 110 | 111 | void setCalibration() { 112 | // Run DMP auto calibration and then get those values and save to EEprom 113 | // This should only be called when Auto Calibrate option is selected 114 | // to preserve EEPROM life use update instead of write 115 | 116 | // Run autocalibration 6 times 117 | mpu.CalibrateAccel(6); 118 | mpu.CalibrateGyro(6); 119 | 120 | // Get the final values that were saved and move them to EEPROM 121 | int Data[3]; 122 | // Accel Offsets 123 | I2Cdev::readWords(devAddr, 0x06, 3, (int *)Data); 124 | epromWriteWord(0,Data[0]); 125 | epromWriteWord(2,Data[1]); 126 | epromWriteWord(4,Data[2]); 127 | // Gyro Offsets 128 | I2Cdev::readWords(devAddr, 0x13, 3, (int *)Data); 129 | epromWriteWord(6,Data[0]); 130 | epromWriteWord(8,Data[1]); 131 | epromWriteWord(10,Data[2]); // Last byte written is eeprom address 11 decimal 132 | } 133 | 134 | 135 | 136 | void setup() { 137 | // From JRowber sample to setup MPU6050 connection 138 | #if I2CDEV_IMPLEMENTATION == I2CDEV_ARDUINO_WIRE 139 | Wire.begin(); 140 | Wire.setClock(400000); // 400kHz I2C clock. Comment this line if having compilation difficulties 141 | #elif I2CDEV_IMPLEMENTATION == I2CDEV_BUILTIN_FASTWIRE 142 | Fastwire::setup(400, true); 143 | #endif 144 | 145 | Serial.begin(115200); // Only needed for Debug otherwise can comment out 146 | 147 | // Set menu buttons WITH PULLUPS 148 | pinMode(MENU_BTN, INPUT_PULLUP); 149 | pinMode(ENTER_BTN, INPUT_PULLUP); 150 | 151 | // Init OLED Display 152 | display.begin(SSD1306_SWITCHCAPVCC, 0x3C); 153 | 154 | display.clearDisplay(); 155 | display.setTextSize(2); 156 | display.setTextColor(SSD1306_WHITE); //not really necessary for this display 157 | display.println(); 158 | display.println(F("Starting!!")); 159 | display.display(); 160 | 161 | 162 | // Init MPU6050 163 | mpu.initialize(); 164 | devStatus = mpu.dmpInitialize(); 165 | 166 | // Get stored EEPROM Calibration values and send to MPU 167 | // Otherwise default to predefined and display Calibration needed! 168 | getCalibration(); 169 | 170 | // make sure it worked - Because we are pushing firmware on startup of DMP 171 | // we need to check that everything actually went as planned devStatus 0 is success. 172 | if (devStatus == 0) { 173 | mpu.setDMPEnabled(true); 174 | mpuIntStatus = mpu.getIntStatus(); 175 | // set our DMP Ready flag so the main loop() function knows it's okay to use it 176 | dmpReady = true; 177 | 178 | // get expected DMP packet size for later comparison 179 | packetSize = mpu.dmpGetFIFOPacketSize(); 180 | 181 | } else { 182 | // IMU Failed for some reason show error on OLED 183 | display.clearDisplay(); 184 | display.setCursor(0, 40); 185 | display.println("IMU FAIL"); 186 | display.display(); 187 | } 188 | } 189 | 190 | 191 | // Handles display routine for Main menu 192 | void dispMenu(byte itemSelect) { 193 | display.clearDisplay(); 194 | display.setRotation(0); 195 | display.setFont(&FreeMono9pt7b); 196 | display.setCursor(0, 14); 197 | display.setTextColor(WHITE); 198 | display.setTextSize(1); 199 | display.println(F(" Normal")); 200 | display.println(F(" Precision")); 201 | display.println(F(" Calibrate")); 202 | 203 | if (itemSelect == 0) { 204 | display.drawRect(5, 2, 120, 17, SSD1306_WHITE); // Draw box around item 1 205 | } 206 | if (itemSelect == 1) { 207 | display.drawRect(5, 18, 120, 20, SSD1306_WHITE); // Draw box around item 2 208 | } 209 | if (itemSelect == 2) { 210 | display.drawRect(5, 36, 120, 20, SSD1306_WHITE); // Draw box around item 3 211 | } 212 | 213 | // Display everything 214 | display.display(); 215 | } 216 | 217 | // Handles display routine for Calibration sub menu 218 | void dispCalibrate(byte itemSelect) { 219 | display.clearDisplay(); 220 | display.setFont(&FreeMono9pt7b); 221 | display.setCursor(2, 14); 222 | display.setTextColor(WHITE); 223 | display.setTextSize(1); 224 | display.println(F("Lay me down")); 225 | display.println(F(" face up")); 226 | display.setCursor(0, 55); 227 | display.println(F(" START X")); 228 | 229 | if (itemSelect == 0) { 230 | display.drawRect(6, 41, 65, 20, SSD1306_WHITE); //Draw box around START 231 | } 232 | else { 233 | display.drawRect(95, 41, 20, 20, SSD1306_WHITE); //Draw box around X 234 | } 235 | 236 | // Display everything 237 | display.display(); 238 | } 239 | 240 | // Handle user button interactions for the main menu options 241 | void menuMainWait() { 242 | // Show the main Menu text on screen 243 | menuItem = 0; 244 | dispMenu(menuItem); 245 | 246 | // Wait for key press to go to selected item 247 | menuStartTime = millis(); //Reset menu timout 248 | 249 | // Wait for next user action in the menu, if no buttons pressed 250 | // after menuTimeout limit, auto exit the menu 251 | while (millis() - menuStartTime <= menuTimeout) { 252 | if (digitalRead(MENU_BTN) == LOW) { 253 | delay(200); // Debounce 254 | menuStartTime = millis(); // Reset menu timout 255 | menuItem++; 256 | if (menuItem >= 3) { 257 | // We reached menu item limit, roll around to start 258 | menuItem = 0; 259 | dispMenu(menuItem); 260 | } 261 | else { 262 | // Draw rect around next menu item selected 263 | dispMenu(menuItem); 264 | } 265 | } 266 | if (digitalRead(ENTER_BTN) == LOW) { 267 | delay(200); // Debounce 268 | menuStartTime = millis(); // Reset menu timout 269 | if (menuItem == 0) { 270 | // Normal mod,e Angle is rounded to whole number 271 | precisionMode = false; 272 | break; 273 | } 274 | if (menuItem == 1) { 275 | // Precision mode, Angle rounded to 1st decimal place 276 | precisionMode = true; 277 | break; 278 | } 279 | if (menuItem == 2) { 280 | // Show calibration sub menu 281 | menuCalibrateWait(); 282 | break; 283 | } 284 | } 285 | } 286 | } 287 | 288 | // Auto Calibration menu, will use MPU auto calibration feature 289 | // and save the values to EEPROM that are pulled on startup 290 | // Calibration only needs to be run one time and values should stay 291 | // acurate from then on. 292 | // NOTE: Calibration must be done on an already known LEVEL surface that 293 | // is level front to back and side to side like a level table top with the device laying down 294 | // screen facing up. 295 | 296 | void menuCalibrateWait() { 297 | // Show the sub menu for CALIBRATION 298 | menuItem = 1; // Default to EXIT 299 | dispCalibrate(menuItem); 300 | 301 | // Wait for next user action in the menu, if no buttons pressed 302 | // after menuTimeout limit, auto exit the menu 303 | menuStartTime = millis(); // Reset menu start timer 304 | while (millis() - menuStartTime <= menuTimeout) { 305 | if (digitalRead(MENU_BTN) == LOW) { 306 | delay(300); // Debounce 307 | if (menuItem == 1) { 308 | menuItem = 0; 309 | dispCalibrate(menuItem); 310 | } 311 | else { 312 | menuItem = 1; 313 | dispCalibrate(menuItem); 314 | } 315 | } 316 | if (digitalRead(ENTER_BTN) == LOW) { 317 | delay(200); //Debounce 318 | if (menuItem == 0) { 319 | // Start Calbiration process takes a few seconds to run 320 | // So display something to let user know it's working 321 | display.clearDisplay(); 322 | display.setCursor(0, 40); 323 | display.println("CALIBRATING"); 324 | display.display(); 325 | 326 | setCalibration(); // This runs the actual calibration 327 | 328 | display.clearDisplay(); 329 | display.setCursor(0, 40); 330 | display.println("COMPLETE!"); 331 | display.display(); 332 | delay(500); // Give user time to see complete message before exit 333 | break; 334 | } 335 | if (menuItem == 1) { 336 | // X selected - Exit Menus; 337 | break; 338 | } 339 | } 340 | } 341 | } 342 | 343 | 344 | // For OLED, show the angle at the correct orientation based on 345 | // How the level is positioned, whether Precision mode is set 346 | // changes decimal display and font size to fit characters 347 | void formatDisplay(double angleVal, byte dispRotate) { 348 | 349 | display.clearDisplay(); 350 | display.setCursor(0, 0); 351 | display.setFont(); 352 | display.setRotation(dispRotate); 353 | 354 | // Set font size, text position and angle value based on MPU positions and precision setting 355 | // Precision mode shows 1 decimal place value, otherwise round to whole number 356 | if (precisionMode == false) { 357 | if (dispRotate == 0 || dispRotate == 2) { 358 | // Horizontal 359 | display.setCursor(40, 10); 360 | } 361 | else { 362 | // Vertical 363 | display.setCursor(3, 30); 364 | } 365 | 366 | display.setTextSize(5); 367 | display.println(round(abs(angleVal))); 368 | } 369 | else { 370 | // Precision Mode show 1 decimal place smaller font when vertical 371 | if (dispRotate == 0 || dispRotate == 2) { 372 | // Horizontal 373 | display.setTextSize(4); 374 | display.setCursor(20, 10); 375 | } 376 | else { 377 | // Vertical 378 | display.setTextSize(2); 379 | display.setCursor(6, 40); 380 | } 381 | 382 | display.println(abs(angleVal), 1); 383 | } 384 | 385 | // If we are level or plumb +-1 degree Display it under the angle 386 | // again format for rotation position use LEVEL or PLUMB text indicator 387 | // Do this inside a white rectangle with black font so it stands out 388 | // since it will be very small font size 389 | if (round(abs(angleVal)) <= 1) { 390 | display.setTextSize(1); 391 | display.setTextColor(BLACK, WHITE); 392 | if (dispRotate == 0 || dispRotate == 2) { 393 | // Horizontal 394 | display.setCursor(37, 50); 395 | display.println(F(" LEVEL ")); 396 | } 397 | else { 398 | // Vertical 399 | display.setCursor(0, 90); 400 | display.println(F(" PLUMB ")); 401 | } 402 | } 403 | 404 | // Reset text color 405 | display.setTextColor(WHITE, BLACK); 406 | // Show the text 407 | display.display(); 408 | } 409 | 410 | 411 | // MAIN PROGRAM LOOP!! 412 | void loop() { 413 | if (digitalRead(MENU_BTN) == LOW) { 414 | delay(500); 415 | menuMainWait(); 416 | } 417 | // if programming failed, don't try to do anything 418 | if (!dmpReady) return; 419 | // Get the Quaternion values from DMP buffer 420 | if (mpu.dmpGetCurrentFIFOPacket(fifoBuffer)) { 421 | mpu.dmpGetQuaternion(&q, fifoBuffer); 422 | 423 | // Calc angles converting Quaternion to Euler this was giving more stable acurate results compared to 424 | // getting Euler directly from DMP. I think Quaternion conversion takes care of gimble lock. 425 | VectorFloat ea = QtoEulerAngle(q); 426 | 427 | //DEBUG ONLY COMMENT OUT UNLESS NEEDED 428 | /* Serial.print("quat\t"); 429 | Serial.print(ea.x); 430 | Serial.print("\t"); 431 | Serial.print(ea.y); 432 | Serial.print("\t"); 433 | Serial.print(ea.z); 434 | Serial.println("\t"); 435 | */ 436 | 437 | float angVal = 0; 438 | float dispRotate = 0; 439 | 440 | // Figure out how to display the data on OLED at the right rotation 441 | // Like flipping a phone around rotating the display - trial and error...took a while 442 | // TOP IS TOP means TOP of OLED is the TOP of the screen, RIGHT IS TOP Right side of OLED is now the top, etc. 443 | 444 | // TOP IS TOP angling Right side (LEVEL) 445 | if (ea.x > 0 && ea.y > 35 && ea.y <= 90) { 446 | angVal = (90 - ea.y); 447 | dispRotate = 0; 448 | } 449 | // Angling right side up RIGHT is TOP (toward PLUMB) 450 | if (ea.x > 0 && ea.y <= 35 && ea.y > -35) { 451 | angVal = ea.y; 452 | dispRotate = 1; 453 | } 454 | // LEFT IS TOP (PLUMB) 455 | if (ea.x > 0 && ea.y <= -35 && ea.y > -90) { 456 | angVal = ea.y + 90; 457 | dispRotate = 2; 458 | } 459 | // TOP IS TOP angling Left side (LEVEL) 460 | if (ea.x < 0 && ea.y > 35 && ea.y <= 90) { 461 | angVal = (90 - ea.y); 462 | dispRotate = 0; 463 | } 464 | // Upside down - BOTTOM IS TOP (LEVEL) 465 | if (ea.x < 0 && ea.y <= 35 && ea.y > -35) { 466 | angVal = ea.y; 467 | dispRotate = 3; 468 | } 469 | // Upside down - BOTTOM IS TOP 470 | if (ea.x < 0 && ea.y <= -35 && ea.y > -90) { 471 | angVal = ea.y + 90; 472 | dispRotate = 2; 473 | } 474 | // laying down face up - this is also Calibration position 475 | // need to also check Z here or it can get confused with another position 476 | if (ea.x < 5 && ea.x > -20 && ea.y <= 35 && ea.y > -35 && ea.z < 5) { 477 | angVal = 90 - ea.y; 478 | if (angVal > 50) { 479 | angVal -= 90; // bandaid fix from being laid flat... 480 | } 481 | dispRotate = 0; 482 | } 483 | 484 | // Display the data on OLED formatted as we need for the position 485 | formatDisplay(angVal, dispRotate); 486 | } 487 | } 488 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Design Build Destroy - Digital Level 2 | 3 | [![Design Build Destroy Arduino Digital Level](http://img.youtube.com/vi/232jer4HIZc/0.jpg)](http://www.youtube.com/watch?v=232jer4HIZc) 4 | 5 | A Digital Spirit Level using Arduino Nano and MPU6050 that can show precise angles up to a little more than 45 degrees. Mimics the 3 measurements of any decent standard bubbel level, Horizontal LEVEL, Vertical PLUMB and 45 Degree. Designed with a 3d printed enclosure that is sturdy and looks like any standard level. 6 | 7 | ## Features 8 | - OLED Display to display current angle and LEVEL/PLUMB indicator, menu options 9 | - Auto screen rotation so the text is always readable no matter what angle the device is held at including upside down. 10 | - Auto Calibration for first time setup 11 | - Menu options for Normal display (angle rounded to nearest whole number) or Precision mode (angle will include 1 decimal point value) & Auto Calibration 12 | - Calibration values saved to internal EEProm so it only needs to be performed once 13 | 14 | ## Watch the build video https://www.youtube.com/watch?v=232jer4HIZc 15 | 16 | ### Visit https://designbuilddestroy.com/digital-level for build details, wiring diagrams & 3d printable enclosure files. 17 | -------------------------------------------------------------------------------- /digital_level_diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DesignBuildDestroy/digital_spirit_level/4f561756c04838befe6a6532ad2767182b10a7cc/digital_level_diagram.png --------------------------------------------------------------------------------