Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
programming_weatherduino_devices [2018/05/15 22:18] – [What I need to program the Receiver, Transmitter or any other WeatherDuino device?] werk_agprogramming_weatherduino_devices [2019/03/18 02:12] (current) – [LOLIN (WeMos) D1 R2 & mini. How to upload files to the SPIFFS memory?] werk_ag
Line 1: Line 1:
 ====== Programming WeatherDuino devices ====== ====== Programming WeatherDuino devices ======
- 
  
 ===== Where do I find the WeatherDuino Software? ===== ===== Where do I find the WeatherDuino Software? =====
-All system builders can download the WeatherDuino software from the [[http://www.meteocercal.info/forum/Forum-WeatherDuino-Downloads|Download Area]] on the WeatherDuino support forum.\\  
-Weatherduino source code is published under GNU General Public License v3.0\\  
  
 +All system builders can download the WeatherDuino software from the [[http://www.meteocercal.info/forum/Forum-WeatherDuino-Downloads|Download Area]] of the WeatherDuino support forum.\\
 +The WeatherDuino source code is published under GNU General Public License v3.0
  
-===== What I need to program the Receiver, Transmitter or any other WeatherDuino device? ===== +===== What do I need in order to program the Receiver, Transmitter or any other WeatherDuino device? =====
-The Arduino IDE is used to compile and upload the WeatherDuino software to the microcontroller used in each unit.\\ +
  
 +The Arduino Integrated Development Environment (IDE) is used to compile and upload the WeatherDuino software to the microcontroller used in each unit.
  
 ===== Do I need to have Arduino programming skills? ===== ===== Do I need to have Arduino programming skills? =====
  
-No, there is no need to have programming skills. However its assumed the user have a minimal knowledge of the Arduino IDE environment. Knowing how to install libraries, as also being able to do minimal code edition, its necessary .\\ +No, there is no need to have programming skills. However its assumed that the user has a minimal knowledge of the Arduino IDE. It is necessary to know how to install libraries and how to make minor edits to code.\\ 
-Edition of the code is required only to change the value of some pre-defined settings, to make that the software will correctly work with the set of weather instruments you intend to use, and to define some user preferences, as using metric or imperial units.\\+Editing the code is only required to change the value of some pre-defined settings, to make the software work correctly with the set of weather instruments you intend to use, and to define some user preferences, such as using metric or imperial units.\\
 \\ \\
-Bellow is an example of the type of code edition the user must do.\\ +Below is an example of the code editing the user must do. Basically its only changing the value of pre-defined variables.
-Basically its only changing the value of pre-defined variables. +
- +
-<code> +
-// -------------------------------------------------------------------------------------- +
-//   Define data display units +
-// -------------------------------------------------------------------------------------- +
-#define DATE_TIME_FORMAT  0    // 0 for dd-mm-yyyy, 1 for yyyy/mm/dd +
-#define TEMP_DISPLAY_UNIT 0    // 0 for ºC, 1 for ºF +
-#define ATM_DISPLAY_UNIT  0    // 0 for mBar, 1 for inHg +
-#define RAIN_DISPLAY_UNIT 0    // 0 for mm, 1 for inches +
-#define WIND_DISPLAY_UNIT 0    // 0 for Km/h, 1 for mph, 2 for m/s, 3 for Knots +
-</code> +
- +
- +
-===== Install Arduino libraries ===== +
-The WeatherDuino software, makes use of several Arduino libraries, which always are included in every software package.\\ +
-Those libraries must be installed (copied) to the Arduino libraries folder. On Windows systems, generally this folder is located at: \\ +
- +
-<code> +
-C:\Documents\Arduino\libraries +
-</code> +
- +
-<WRAP round important> +
-Always install all the supplied libraries, no matter if there are newer versions of the same libraries.\\ +
-Most compile errors are due to not following this recommendation. +
-</WRAP> +
- +
-From time to time we may change or upgrade the libraries used by the software. When this happen, always there is a notice in the change.log file that is included in each software release. Read it every time you download a new software version. By other hand, the same notice always is also published on the software download webpage.\\ +
- +
- +
-===== What I need to program the Receiver, Transmitter or any other WeatherDuino device? ===== +
- +
-The Arduino IDE is used to compile and upload the WeatherDuino software to the microcontroller used in each unit. +
- +
-===== Do I need to have Arduino programming skills? ===== +
- +
-No, there is no need to have programming skills. However its assumed the user have a minimal knowledge of the Arduino IDE environment. Knowing how to install libraries, as also being able to do minimal code edition, its necessary .\\ +
-Edition of the code is required only to change the value of some pre-defined settings, to make that the software will correctly work with the set of weather instruments you intend to use, and to define some user preferences, as using metric or imperial units.\\ +
-\\ +
-Bellow is an example of the type of code edition the user must do.\\ +
-Basically its only changing the value of pre-defined variables.+
  
 <code> <code>
Line 72: Line 30:
 ===== Install Arduino libraries ===== ===== Install Arduino libraries =====
  
-The WeatherDuino software, makes use of several Arduino libraries, which always are included in every software package.\\ +The WeatherDuino software makes use of several Arduino libraries, which are always included in every software package.\\ 
-Those libraries must be installed (copied) to the Arduino libraries folder. On Windows systems, generally this folder is located at:+These libraries must be installed (copied) to the Arduino libraries folder. On Windows systems, generally this folder is located at:
  
 <code> <code>
Line 82: Line 40:
 Most compile errors are due to not following this recommendation. </WRAP> Most compile errors are due to not following this recommendation. </WRAP>
  
-From time to time we may change or upgrade the libraries used by the software. When this happen, always there is a notice in the change.log file that is included in each software release. Read it every time you download a new software version. By other hand, the same notice always is also published on the software download webpage.+From time to time we may change or upgrade the libraries used by the software. When this happens, there is always a notice in the change.log file that is included with each software release. Read it every time you download a new software version. The same notice is also published on the software download webpage.
  
-===== Configuring the Software =====+===== Configuring the Software - User Configurable Options =====
  
-On WeatherDuino software, all user configurable options are just in one place.\\ +On WeatherDuino software, all user configurable options are stored in one place.\\ 
-After loading the Weatherduino software with Arduino IDE, you should see a tab with the name Config_Options.h - Click on this tab, all user configurable options are there.\\ +After loading the WeatherDuino software into the Arduino IDE, you should see a tab with the name Config_Options.h - Click on this tab, all user configurable options are there.\\ 
-Before compiling and upload any software to any WeatherDuino unit, its recommended that the user revise and edit this file to suite their own system. Often default options aren't suitable for each user.\\ +Before compiling and uploading any software to any WeatherDuino unit, it is recommended that you look carefully at this file and edit the values to suit your own system. Often the default options aren't suitable for every user.\\ 
-The software for some units, may also have a file called Credentials.h which you will see in the Credentials.h tab. Here is where info like WiFi ID and password, WU credentials, etc. are stored. When present, user should also revise and edit this file as needed.+The software for some devices may also have a file called Credentials.h which you will see in the Credentials.h tab. This is where information such as WiFi ID, WiFi password, WU credentials, etc. are stored. If this file is present you should revise and edit the values as necessary.
  
-{{:wiki:faq_arduinoide_config_options.jpg?nolink&}}+{{:wiki:faq_arduinoide_config_options.jpg?nolink&|faq_arduinoide_config_options.jpg}}
  
-===== WeMos D1 R2 & mini isn't listed in my list of available boards. How to add it? =====+===== LOLIN (WeMos) D1 R2 & mini isn't listed in my list of available boards. How do I add it? =====
  
 In your Arduino IDE: In your Arduino IDE:
  
   * Open Preferences window.   * Open Preferences window.
-  * Into Additional Board Manager URLs field, copy and past this URL:+  * Paste this URL into the Additional Board Manager URLs field:
  
 <code> <code>
Line 104: Line 62:
 </code> </code>
  
-  * After installation, you should have a lot of new boards types available, including the WeMos D1 R2 & mini+  * After installation, you should have many new types of boards available, including the WeMos D1 R2 & mini
  
-For OTA software upgrades also need to install Python 2.7 (do not install Python 3.5 that is not supported). \\ Download it from here: [[https://www.python.org/downloads/release/python-2714/|https://www.python.org/downloads/release/python-2714/]] \\ 
-During install select the option as pictured in the image bellow. 
  
-{{:wiki:ota-ide-python-configuration.png?nolink&390x335}}+===== LOLIN (WeMos) D1 R2 & mini. How to upload files to the SPIFFS memory? =====
  
 +To upload the fonts and icons to SPIFFS use the "ESP8266 Sketch Data Upload" menu option in the Arduino IDE.\\
 +If you don't see this option, to add it follow instructions here: https://github.com/esp8266/arduino-esp8266fs-plugin\\ 
 +or (the easy way) just copy to your Sketchbook location (on Windows, usually C:\Users\xxxxxx\Documents\Arduino)\\
 +the "tools" directory, included WeatherDuino software package (look in utilities folder).\\
 +\\
 +Close the IDE and open again to see the new menu option.\\
 +===== OTA programming =====
 +
 +Some WeatherDuino devices can be upgraded / programmed by Over The Air (OTA), using your WiFi network. \\ For this to work you need to have Python 2.7 installed in your computer. If it isn't already installed, download it from here: [[https://www.python.org/downloads/release/python-2714/|https://www.python.org/downloads/release/python-2714/]] \\
 +Do not install Python 3.5 as that is not supported. \\
 +During installation select the option as pictured in the image below.
 +
 +{{:wiki:ota-ide-python-configuration.png?nolink&390x335}}
  
  

Trace:

Print/export
QR Code
QR Code programming_weatherduino_devices (generated for current page)