diff --git a/README.md b/README.md index 45790a516c..5bfcca8e76 100644 --- a/README.md +++ b/README.md @@ -28,20 +28,20 @@ ESP8266 Arduino core comes with libraries to communicate over WiFi using TCP and Starting with 1.6.4, Arduino allows installation of third-party platform packages using Boards Manager. We have packages available for Windows, Mac OS, and Linux (32 and 64 bit). -- Install the current upstream Arduino IDE at the 1.8.7 level or later. The current version is at the [Arduino website](http://www.arduino.cc/en/main/software). +- Install the current upstream Arduino IDE at the 1.8.7 level or later. The current version is at the [Arduino website](https://www.arduino.cc/en/main/software). - Start Arduino and open Preferences window. -- Enter ```http://arduino.esp8266.com/stable/package_esp8266com_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas. +- Enter ```https://arduino.esp8266.com/stable/package_esp8266com_index.json``` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas. - Open Boards Manager from Tools > Board menu and install *esp8266* platform (and don't forget to select your ESP8266 board from Tools > Board menu after installation). #### Latest release [![Latest release](https://img.shields.io/github/release/esp8266/Arduino.svg)](https://github.com/esp8266/Arduino/releases/latest/) -Boards manager link: `http://arduino.esp8266.com/stable/package_esp8266com_index.json` +Boards manager link: `https://arduino.esp8266.com/stable/package_esp8266com_index.json` Documentation: [https://arduino-esp8266.readthedocs.io/en/2.5.0/](https://arduino-esp8266.readthedocs.io/en/2.5.0/) ### Using git version (basic instructions) [![Linux build status](https://travis-ci.org/esp8266/Arduino.svg)](https://travis-ci.org/esp8266/Arduino) -- Install the current upstream Arduino IDE at the 1.8 level or later. The current version is at the [Arduino website](http://www.arduino.cc/en/main/software). +- Install the current upstream Arduino IDE at the 1.8 level or later. The current version is at the [Arduino website](https://www.arduino.cc/en/main/software). - Go to Arduino directory - For Mac OS X, it is `Arduino.app` showing as the Arduino icon. This location may be your `~/Downloads`, `~/Desktop` or even `/Applications`. @@ -70,19 +70,19 @@ python get.py ### Using PlatformIO -[PlatformIO](http://platformio.org?utm_source=github&utm_medium=arduino-esp8266) is an open source ecosystem for IoT +[PlatformIO](https://platformio.org?utm_source=github&utm_medium=arduino-esp8266) is an open source ecosystem for IoT development with cross platform build system, library manager and full support for Espressif (ESP8266) development. It works on the popular host OS: macOS, Windows, Linux 32/64, Linux ARM (like Raspberry Pi, BeagleBone, CubieBoard). -- [What is PlatformIO?](http://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=arduino-esp8266) -- [PlatformIO IDE](http://platformio.org/platformio-ide?utm_source=github&utm_medium=arduino-esp8266) -- [PlatformIO Core](http://docs.platformio.org/en/latest/core.html?utm_source=github&utm_medium=arduino-esp8266) (command line tool) -- [Advanced usage](http://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=github&utm_medium=arduino-esp8266) - +- [What is PlatformIO?](https://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=github&utm_medium=arduino-esp8266) +- [PlatformIO IDE](https://platformio.org/platformio-ide?utm_source=github&utm_medium=arduino-esp8266) +- [PlatformIO Core](https://docs.platformio.org/en/latest/core.html?utm_source=github&utm_medium=arduino-esp8266) (command line tool) +- [Advanced usage](https://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=github&utm_medium=arduino-esp8266) - custom settings, uploading to SPIFFS, Over-the-Air (OTA), staging version -- [Integration with Cloud and Standalone IDEs](http://docs.platformio.org/en/latest/ide.html?utm_source=github&utm_medium=arduino-esp8266) - +- [Integration with Cloud and Standalone IDEs](https://docs.platformio.org/en/latest/ide.html?utm_source=github&utm_medium=arduino-esp8266) - Cloud9, Codeanywhere, Eclipse Che (Codenvy), Atom, CLion, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, VIM, Visual Studio, and VSCode -- [Project Examples](http://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=github&utm_medium=arduino-esp8266#examples) +- [Project Examples](https://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=github&utm_medium=arduino-esp8266#examples) ### Building with make @@ -95,7 +95,7 @@ Documentation for latest development version: https://arduino-esp8266.readthedoc ### Issues and support ### -[ESP8266 Community Forum](http://www.esp8266.com/u/arduinoanswers) is a well established community for questions and answers about Arduino for ESP8266. If you need help, have a "How do I..." type question, have a problem with a 3rd party lib not hosted in this repo, or just want to discuss how to approach a problem , please ask there. +[ESP8266 Community Forum](https://www.esp8266.com/u/arduinoanswers) is a well established community for questions and answers about Arduino for ESP8266. If you need help, have a "How do I..." type question, have a problem with a 3rd party lib not hosted in this repo, or just want to discuss how to approach a problem , please ask there. If you find the forum useful, please consider supporting it with a donation.
[![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/webscr?cmd=_s-xclick&hosted_button_id=4M56YCWV6PX66) diff --git a/doc/eclipse/eclipse.rst b/doc/eclipse/eclipse.rst index 285e121765..4a6fe32812 100644 --- a/doc/eclipse/eclipse.rst +++ b/doc/eclipse/eclipse.rst @@ -6,8 +6,8 @@ What to Download - `arduino IDE `__ - `Eclipse IDE for C/C++ - Developers `__ -- `Java `__ + Developers `__ +- `Java `__ Setup Arduino ~~~~~~~~~~~~~ @@ -18,8 +18,8 @@ See the Setup Eclipse ~~~~~~~~~~~~~ -- `step 1 `__ -- `step 2 `__ +- `step 1 `__ +- `step 2 `__ - go to Window --> preferences --> Arduino - add as private hardware path the Part to the ESP8266 diff --git a/doc/esp8266wifi/client-examples.rst b/doc/esp8266wifi/client-examples.rst index d3b63bc8ae..b5bb605862 100644 --- a/doc/esp8266wifi/client-examples.rst +++ b/doc/esp8266wifi/client-examples.rst @@ -230,7 +230,7 @@ End of header is marked with an empty line and then you should see the HTML code

Example Domain

This domain is established to be used for illustrative examples in documents. You may use this domain in examples without prior coordination or asking for permission.

-

More information...

+

More information...

diff --git a/doc/esp8266wifi/readme.rst b/doc/esp8266wifi/readme.rst index 8de3aaac43..098a482eb5 100644 --- a/doc/esp8266wifi/readme.rst +++ b/doc/esp8266wifi/readme.rst @@ -7,7 +7,7 @@ ESP8266 is all about Wi-Fi. If you are eager to connect your new ESP8266 module Introduction ------------ -The `Wi-Fi library for ESP8266 `__ has been developed based on `ESP8266 SDK `__, using naming convention and overall functionality philosophy of `Arduino WiFi library `__. Over time the wealth Wi-Fi features ported from ESP9266 SDK to `esp8266 / +The `Wi-Fi library for ESP8266 `__ has been developed based on `ESP8266 SDK `__, using naming convention and overall functionality philosophy of `Arduino WiFi library `__. Over time the wealth Wi-Fi features ported from ESP9266 SDK to `esp8266 / Arduino `__ outgrew `Arduino WiFi library `__ and it became apparent that we need to provide separate documentation on what is new and extra. This documentation will walk you through several classes, methods and properties of `ESP8266WiFi `__ library. If you are new to C++ and Arduino, don't worry. We will start from general concepts and then move to detailed description of members of each particular class including usage examples. @@ -72,7 +72,7 @@ Connection process can take couple of seconds and we are checking for this to co The ``while()`` loop will keep looping while ``WiFi.status()`` is other than ``WL_CONNECTED``. The loop will exit only if the status changes to ``WL_CONNECTED``. -The last line will then print out IP address assigned to ESP module by `DHCP `__: +The last line will then print out IP address assigned to ESP module by `DHCP `__: .. code:: cpp @@ -205,7 +205,7 @@ Check out separate section with `examples `__ / `list of funct Generic ~~~~~~~ -There are several functions offered by ESP8266's `SDK `__ and not present in `Arduino WiFi library `__. If such function does not fit into one of classes discussed above, it will likely be in Generic Class. Among them is handler to manage Wi-Fi events like connection, disconnection or obtaining an IP, Wi-Fi mode changes, functions to manage module sleep mode, hostname to an IP address resolution, etc. +There are several functions offered by ESP8266's `SDK `__ and not present in `Arduino WiFi library `__. If such function does not fit into one of classes discussed above, it will likely be in Generic Class. Among them is handler to manage Wi-Fi events like connection, disconnection or obtaining an IP, Wi-Fi mode changes, functions to manage module sleep mode, hostname to an IP address resolution, etc. Check out separate section with `examples `__ / `list of functions `__. @@ -307,7 +307,7 @@ What's Inside? If you like to analyze in detail what is inside of the ESP8266WiFi library, go directly to the `ESP8266WiFi `__ folder of esp8266 / Arduino repository on the GitHub. -To make the analysis easier, rather than looking into individual header or source files, use one of free tools to automatically generate documentation. The class index in chapter `Class Description`_ above has been prepared in no time using great `Doxygen `__, that is the de facto standard tool for generating documentation from annotated C++ sources. +To make the analysis easier, rather than looking into individual header or source files, use one of free tools to automatically generate documentation. The class index in chapter `Class Description`_ above has been prepared in no time using great `Doxygen `__, that is the de facto standard tool for generating documentation from annotated C++ sources. .. figure:: pictures/doxygen-esp8266wifi-documentation.png :alt: Example of documentation prepared by Doxygen @@ -325,4 +325,4 @@ If code is not annotated, you will still see the function prototype including ty .. figure:: pictures/doxygen-example-udp-begin.png :alt: Example of documentation for UDP begin method (not annotaed in code)by Doxygen -Several classes of `ESP8266WiFi `__ are not annotated. When preparing this document, `Doxygen `__ has been tremendous help to quickly navigate through almost 30 files that make this library. +Several classes of `ESP8266WiFi `__ are not annotated. When preparing this document, `Doxygen `__ has been tremendous help to quickly navigate through almost 30 files that make this library. diff --git a/doc/esp8266wifi/server-examples.rst b/doc/esp8266wifi/server-examples.rst index 9169020b21..8fe5f71acf 100644 --- a/doc/esp8266wifi/server-examples.rst +++ b/doc/esp8266wifi/server-examples.rst @@ -53,7 +53,7 @@ Then let's write a short function ``prepareHtmlPage()``, that will return a ``St return htmlPage; } -The function does nothing fancy but just puts together a text header and `HTML `__ contents of the page. +The function does nothing fancy but just puts together a text header and `HTML `__ contents of the page. Header First ~~~~~~~~~~~~ @@ -75,7 +75,7 @@ In our example the content type is ``text/html``, the connection will be closed Analog input: [Value] -The content contains two basic `HTML `__ tags, one to denote HTML document type ```` and another to mark beginning ```` and end ```` of the document. Inside there is a raw value read from ESP's analog input ``analogRead(A0)`` converted to the ``String`` type. +The content contains two basic `HTML `__ tags, one to denote HTML document type ```` and another to mark beginning ```` and end ```` of the document. Inside there is a raw value read from ESP's analog input ``analogRead(A0)`` converted to the ``String`` type. .. code:: cpp diff --git a/doc/esp8266wifi/soft-access-point-class.rst b/doc/esp8266wifi/soft-access-point-class.rst index 9cf7b1645c..473960fd63 100644 --- a/doc/esp8266wifi/soft-access-point-class.rst +++ b/doc/esp8266wifi/soft-access-point-class.rst @@ -61,7 +61,7 @@ Function will return ``true`` or ``false`` depending on result of setting the so Notes: - The network established by softAP will have default IP address of 192.168.4.1. This address may be changed using ``softAPConfig`` (see below). -- Even though ESP8266 can operate in soft-AP + station mode, it actually has only one hardware channel. Therefore in soft-AP + station mode, the soft-AP channel will default to the number used by station. For more information how this may affect operation of stations connected to ESP8266's soft-AP, please check `this FAQ entry `__ on Espressif forum. +- Even though ESP8266 can operate in soft-AP + station mode, it actually has only one hardware channel. Therefore in soft-AP + station mode, the soft-AP channel will default to the number used by station. For more information how this may affect operation of stations connected to ESP8266's soft-AP, please check `this FAQ entry `__ on Espressif forum. softAPConfig ^^^^^^^^^^^^ diff --git a/doc/esp8266wifi/station-class.rst b/doc/esp8266wifi/station-class.rst index 245fb60594..464f4a4d65 100644 --- a/doc/esp8266wifi/station-class.rst +++ b/doc/esp8266wifi/station-class.rst @@ -501,7 +501,7 @@ Basing on this example, when running above code, module is initially disconnecte SSID ^^^^ -Return the name of Wi-Fi network, formally called `Service Set Identification (SSID) `__. +Return the name of Wi-Fi network, formally called `Service Set Identification (SSID) `__. .. code:: cpp @@ -535,7 +535,7 @@ Function returns value of the ``String`` type. BSSID ^^^^^ -Return the mac address of the access point to which the ESP module was directed to connect to. This address is formally called `Basic Service Set Identification (BSSID) `__. The returned pointer is what the user configured when calling begin() with a bssid argument. It does _not_ necessarily reflect the mac address of the access point to which the ESP module's station interface is currently connected to. +Return the mac address of the access point to which the ESP module was directed to connect to. This address is formally called `Basic Service Set Identification (BSSID) `__. The returned pointer is what the user configured when calling begin() with a bssid argument. It does _not_ necessarily reflect the mac address of the access point to which the ESP module's station interface is currently connected to. .. code:: cpp @@ -587,12 +587,12 @@ Signal strength value is provided in dBm. The type of returned value is ``int32_ Connect Different ~~~~~~~~~~~~~~~~~ -`ESP8266 SDK `__ provides alternate methods to connect ESP station to an access point. Out of them `esp8266 / Arduino `__ core implements `WPS <#wps>`__ and `Smart Config <#smart-config>`__ as described in more details below. +`ESP8266 SDK `__ provides alternate methods to connect ESP station to an access point. Out of them `esp8266 / Arduino `__ core implements `WPS <#wps>`__ and `Smart Config <#smart-config>`__ as described in more details below. WPS ^^^ -The following ``beginWPSConfig`` function allows connecting to a network using `Wi-Fi Protected Setup (WPS) `__. Currently only `push-button configuration `__ (``WPS_TYPE_PBC`` mode) is supported (SDK 1.5.4). +The following ``beginWPSConfig`` function allows connecting to a network using `Wi-Fi Protected Setup (WPS) `__. Currently only `push-button configuration `__ (``WPS_TYPE_PBC`` mode) is supported (SDK 1.5.4). .. code:: cpp @@ -661,4 +661,4 @@ Stop smart config, free the buffer taken by ``beginSmartConfig()``. Depending on stopSmartConfig() -For additional details regarding Smart Config please refer to `ESP8266 API User Guide `__. +For additional details regarding Smart Config please refer to `ESP8266 API User Guide `__. diff --git a/doc/faq/a01-espcomm_sync-failed.rst b/doc/faq/a01-espcomm_sync-failed.rst index c91cc32678..699754ecf8 100644 --- a/doc/faq/a01-espcomm_sync-failed.rst +++ b/doc/faq/a01-espcomm_sync-failed.rst @@ -264,7 +264,7 @@ by user [@mytrain](https://github.com/mytrain) and discussed in If you prefer external terminal program, then for Windows users we can recommend free and handy -`Termite `__. +`Termite `__. Nodemcu ^^^^^^^ @@ -370,7 +370,7 @@ If this is still not the case, then review once more all discussed steps in the * [ ] What is the name and version of your IDE and O/S? -If you are stuck at certain step, then post this list on `ESP8266 Community Forum `__ asking for support. +If you are stuck at certain step, then post this list on `ESP8266 Community Forum `__ asking for support. Conclusion ~~~~~~~~~~ @@ -389,7 +389,7 @@ detailed upload log for inconsistencies with IDE settings. Verify your connection diagram and wave-form for consistency with selected reset method. -If you get stuck, then ask `community `__ for +If you get stuck, then ask `community `__ for support providing summary of all completed checks. .. figure:: pictures/a01-test-stand.jpg diff --git a/doc/faq/a02-my-esp-crashes.rst b/doc/faq/a02-my-esp-crashes.rst index ae6900c4f0..90d70c024e 100644 --- a/doc/faq/a02-my-esp-crashes.rst +++ b/doc/faq/a02-my-esp-crashes.rst @@ -120,7 +120,7 @@ ESP provides two watchdog timers (wdt) that observe application for lock up. - **Software Watchdog** - provided by - `SDK `__, that is part + `SDK `__, that is part of `esp8266 / arduino `__ core loaded to module together with your application. - **Hardware Watchdog** - build in ESP8266 hardware and acting if diff --git a/doc/faq/readme.rst b/doc/faq/readme.rst index 964c9ee17a..ee76138dff 100644 --- a/doc/faq/readme.rst +++ b/doc/faq/readme.rst @@ -3,7 +3,7 @@ FAQ The purpose of this FAQ / Troubleshooting is to respond to questions commonly asked in `Issues `__ -section and on `ESP8266 Community forum `__. +section and on `ESP8266 Community forum `__. Where possible we are going right to the answer and provide it within one or two paragraphs. If it takes more than that, you will see a link diff --git a/doc/gdb.rst b/doc/gdb.rst index dac5658151..bf722c8165 100644 --- a/doc/gdb.rst +++ b/doc/gdb.rst @@ -220,16 +220,16 @@ Open up the proper ESP8266-specific GDB earle@server:~$ ~/.arduino15/packages/esp8266/hardware/xtensa-lx106-elf/bin/xtensa-lx106-elf-gdb GNU gdb (GDB) 8.2.50.20180723-git Copyright (C) 2018 Free Software Foundation, Inc. - License GPLv3+: GNU GPL version 3 or later + License GPLv3+: GNU GPL version 3 or later This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. Type "show copying" and "show warranty" for details. This GDB was configured as "--host=x86_64-linux-gnu --target=xtensa-lx106-elf". Type "show configuration" for configuration details. For bug reporting instructions, please see: - . + . Find the GDB manual and other documentation resources online at: - . + . For help, type "help". Type "apropos word" to search for commands related to "word". diff --git a/doc/installing.rst b/doc/installing.rst index b89f574826..a2c2b00e28 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -18,7 +18,7 @@ Instructions - Start Arduino and open Preferences window. - Enter - ``http://arduino.esp8266.com/stable/package_esp8266com_index.json`` + ``https://arduino.esp8266.com/stable/package_esp8266com_index.json`` into *Additional Board Manager URLs* field. You can add multiple URLs, separating them with commas. - Open Boards Manager from Tools > Board menu and find *esp8266* @@ -28,11 +28,6 @@ Instructions - Don't forget to select your ESP8266 board from Tools > Board menu after installation. -You may optionally use *staging* boards manager package link: -``http://arduino.esp8266.com/staging/package_esp8266com_index.json``. -This may contain some new features, but at the same time, some things -might be broken. - For more information on the Arduino Board Manager, see: - https://www.arduino.cc/en/guide/cores @@ -48,7 +43,7 @@ Prerequisites - Arduino 1.6.8 (or newer, current working version is 1.8.5) - git -- Python 2.7 (http://python.org) +- Python 2.7 (https://python.org) - terminal, console, or command prompt (depending on your OS) - Internet connection diff --git a/doc/libraries.rst b/doc/libraries.rst index b61cdb9e2b..d53d0e87de 100644 --- a/doc/libraries.rst +++ b/doc/libraries.rst @@ -158,7 +158,7 @@ Libraries that don't rely on low-level access to AVR registers should work well. - `arduinoVNC `__ - VNC Client for Arduino - `arduinoWebSockets `__ - WebSocket Server and Client compatible with ESP8266 (RFC6455) - `aREST `__ - REST API handler library. -- `Blynk `__ - easy IoT framework for Makers (check out the `Kickstarter page `__). +- `Blynk `__ - easy IoT framework for Makers (check out the `Kickstarter page `__). - `DallasTemperature `__ - `DHT-sensor-library `__ - Arduino library for the DHT11/DHT22 temperature and humidity sensors. Download latest v1.1.1 library and no changes are necessary. Older versions should initialize DHT as follows: ``DHT dht(DHTPIN, DHTTYPE, 15)`` - `DimSwitch `__ - Control electronic dimmable ballasts for fluorescent light tubes remotely as if using a wall switch. diff --git a/doc/ota_updates/readme.rst b/doc/ota_updates/readme.rst index f1efb39db0..9c47a88309 100644 --- a/doc/ota_updates/readme.rst +++ b/doc/ota_updates/readme.rst @@ -291,9 +291,9 @@ If OTA update fails, first step is to check for error messages that may be shown This window is for Arduino Yún and not yet implemented for esp8266/Arduino. It shows up because IDE is attempting to open Serial Monitor using network port you have selected for OTA upload. -Instead you need an external serial monitor. If you are a Windows user check out `Termite `__. This is handy, slick and simple RS232 terminal that does not impose RTS or DTR flow control. Such flow control may cause issues if you are using respective lines to toggle GPIO0 and RESET pins on ESP for upload. +Instead you need an external serial monitor. If you are a Windows user check out `Termite `__. This is handy, slick and simple RS232 terminal that does not impose RTS or DTR flow control. Such flow control may cause issues if you are using respective lines to toggle GPIO0 and RESET pins on ESP for upload. -Select COM port and baud rate on external terminal program as if you were using Arduino Serial Monitor. Please see typical settings for `Termite `__ below: +Select COM port and baud rate on external terminal program as if you were using Arduino Serial Monitor. Please see typical settings for `Termite `__ below: .. figure:: termite-configuration.png :alt: Termite settings @@ -380,8 +380,8 @@ You can use another module if it meets previously described `requirements <#basi https://github.com/esp8266/Arduino#installing-with-boards-manager - Host software depending on O/S you use: - 1. Avahi http://avahi.org/ for Linux - 2. Bonjour http://www.apple.com/support/bonjour/ for Windows + 1. Avahi https://avahi.org/ for Linux + 2. Bonjour https://www.apple.com/support/bonjour/ for Windows 3. Mac OSX and iOS - support is already built in / no any extra s/w is required @@ -451,7 +451,7 @@ You can use another module if it meets previously described `requirements <#basi :alt: Serial Monitor - after OTA update Just after reboot you should see exactly the same message - ``HTTPUpdateServer ready! Open http:// esp8266-webupdate.local /update in your browser`` + ``HTTPUpdateServer ready! Open http://esp8266-webupdate.local/update in your browser`` like in step 3. This is because module has been loaded again with the same code – first using serial port, and then using OTA. diff --git a/package/README.md b/package/README.md index 3a8e6e7c6c..c80f6a6998 100644 --- a/package/README.md +++ b/package/README.md @@ -56,7 +56,7 @@ Here is an overview of the release process. See the section below for detailed i 4. Travis CI uploads boards manager package (.zip file) and package index (.json file) to Github Releases, creating a draft release at the same time. -5. Travis CI also uploads package index .json file to `http://arduino.esp8266.com/stable/package_esp8266_index.json`, i.e. well-known URL used by most users. +5. Travis CI also uploads package index .json file to `https://arduino.esp8266.com/stable/package_esp8266_index.json`, i.e. well-known URL used by most users. 6. When the draft release is created, maintainer edits release description and inserts changelog into the description field, unmarks the release as draft, and publishes the release. @@ -123,7 +123,7 @@ The following points assume work in a direct clone of the repository, and not in 6. Check that the new (draft) release has been created (no editing at this point!), see https://github.com/esp8266/Arduino/releases. Check that the boards manager package .zip file has been successfully uploaded as a release artifact. -7. Check that the package index downloaded from http://arduino.esp8266.com/stable/package_esp8266com_index.json contains an entry for the new version (it may not be the first one). +7. Check that the package index downloaded from https://arduino.esp8266.com/stable/package_esp8266com_index.json contains an entry for the new version (it may not be the first one). 8. Navigate to release list in Github here https://github.com/esp8266/Arduino/releases, press "Edit" button to edit release description, paste release notes, and publish it. diff --git a/package/build_boards_manager_package.sh b/package/build_boards_manager_package.sh index 80592b3fd8..1a310b10ce 100755 --- a/package/build_boards_manager_package.sh +++ b/package/build_boards_manager_package.sh @@ -155,7 +155,8 @@ curl -L -o $old_json "https://github.com/esp8266/Arduino/releases/download/${bas new_json=package_esp8266com_index.json set +e -python ../../merge_packages.py $new_json $old_json >tmp && mv tmp $new_json && rm $old_json +# Merge the old and new, then drop any obsolete package versions +python ../../merge_packages.py $new_json $old_json | python ../../drop_versions.py - platforms 1.6.5-947-g39819f0 2.5.0-beta1 2.5.0-beta2 2.5.0-beta3 2.4.0-rc1 2.4.0-rc2 >tmp && mv tmp $new_json && rm $old_json popd popd diff --git a/package/drop_version.py b/package/drop_version.py new file mode 100755 index 0000000000..e2eef7a656 --- /dev/null +++ b/package/drop_version.py @@ -0,0 +1,43 @@ +#!/usr/bin/env python +# This script drops one or multiple versions of a release +# +from __future__ import print_function +import json +import sys + +def load_package(filename): + if filename == "-": + pkg = json.load(sys.stdin)['packages'][0] + else: + pkg = json.load(open(filename))['packages'][0] + print("Loaded package {0} from {1}".format(pkg['name'], filename), file=sys.stderr) + print("{0} platform(s), {1} tools".format(len(pkg['platforms']), len(pkg['tools'])), file=sys.stderr) + return pkg + +# There's probably a lambda way of doing this, but I can't figure it out... +def drop_version(todrop, obj): + out = []; + for o in obj: + version = o['version'].encode('ascii') + if version == todrop: + print("Dropping version {0}".format(todrop)) + else: + out.append(o) + return out + +def main(args): + if len(args) < 3: + print("Usage: {0}
...".format(args[0]), file=sys.stderr) + return 1 + + pkg = load_package(args[1]) + section = args[2] + sub = pkg[section] + for ver in args[3:]: + sub = drop_version(ver, sub) + pkg[section] = sub + + json.dump({'packages':[pkg]}, sys.stdout, indent=2) + +if __name__ == '__main__': + sys.exit(main(sys.argv)) diff --git a/package/esp8266-arduino-doc.bash b/package/esp8266-arduino-doc.bash index f02736ace9..c288a948de 100755 --- a/package/esp8266-arduino-doc.bash +++ b/package/esp8266-arduino-doc.bash @@ -31,7 +31,7 @@ release_date=$(date "+%b_%d,_%Y") # format for badge link build_date=$(date "+%b %d, %Y") destination_path="$tmp_path/doc" doc_template_url="https://github.com/igrr/esp8266-arduino-docs.git" -url="http://esp8266.github.io/Arduino" +url="https://esp8266.github.io/Arduino" # control output echo "Arduino ESP8266 source dir: "$arduinoESP_src diff --git a/package/package_esp8266com_index.template.json b/package/package_esp8266com_index.template.json index ec2314f7e1..2d08d116aa 100644 --- a/package/package_esp8266com_index.template.json +++ b/package/package_esp8266com_index.template.json @@ -6,7 +6,7 @@ "websiteURL": "https://github.com/esp8266/Arduino", "email": "ivan@esp8266.com", "help": { - "online": "http://esp8266.com/arduino" + "online": "https://esp8266.com/arduino" }, "platforms": [ { diff --git a/tools/elf2bin.py b/tools/elf2bin.py index 3e70caf14a..5d63c4fdbb 100755 --- a/tools/elf2bin.py +++ b/tools/elf2bin.py @@ -16,7 +16,7 @@ # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# along with this program. If not, see . import argparse import re diff --git a/tools/makecorever.py b/tools/makecorever.py index 95928bd1a0..61b6b98c22 100755 --- a/tools/makecorever.py +++ b/tools/makecorever.py @@ -15,7 +15,7 @@ # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with this program. If not, see . +# along with this program. If not, see . import argparse import os diff --git a/tools/platformio-build.py b/tools/platformio-build.py index a784753b76..dd79c7cfd6 100644 --- a/tools/platformio-build.py +++ b/tools/platformio-build.py @@ -4,7 +4,7 @@ # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # -# http://www.apache.org/licenses/LICENSE-2.0 +# https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, @@ -19,7 +19,7 @@ control devices attached to a wide range of Arduino boards to create all kinds of creative coding, interactive objects, spaces or physical experiences. -http://arduino.cc/en/Reference/HomePage +https://arduino.cc/en/Reference/HomePage """ # Extends: https://github.com/platformio/platform-espressif8266/blob/develop/builder/main.py