1
0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-22 21:23:07 +03:00

131 Commits

Author SHA1 Message Date
Kyle Lobo
ec7bdfa284 Fix editing, typos and grammatical errors (#6207)
1. The current version is ~at~ on the Arduino website
2. Start Arduino and open _the_ Preferences window
3. Enter ```https://arduino.esp8266.com/stable/package_esp8266com_index.json``` into _the_ *Additional Board Manager URLs* field
4. The current version is ~at~ on the Arduino website
5. [PlatformIO](https://platformio.org?utm_source=github&utm_medium=arduino-esp8266) is an open source ecosystem for IoT
development with _a_ ~cross platform~ cross-platform build system, library manager and full support
6. [ESP8266 Community Forum](https://www.esp8266.com/u/arduinoanswers) is a ~well established~ well-established community
7. or just want to discuss how to approach a problem, (removed extra space after 'problem')
8. when encountering an issue ~which~ that happens at run time
9. attach _the_ serial output
10. Check out the list of issues ~which~ that are easy to fix
11. It is distributed under _the_ MIT license.
12. It is distributed under _the_ MIT license.
2019-06-17 16:40:46 -07:00
Earle F. Philhower, III
a389a995fb Add LittleFS as an optional filesystem, API compatible w/SPIFFS (but not on-flash-format compatible) (#5511)
* Add LittleFS as internal flash filesystem

Adds a LittleFS object which uses the ARMmbed littlefs embedded filesystem,
https://github.com/ARMmbed/littlefs, to enable a new filesystem for onboard
flash utilizing the exact same API as the existing SPIFFS filesystem.

LittleFS is built for low memory systems that are subject to random power
losses, is actively supported by the ARMmbed community, supports directories,
and seems to be much faster in the large-ish read-mostly applications I use.

LittleFS, however, has a larger minimum file allocation unit and does not do
static wear levelling.  This means that for systems that need many little
files (<4K), have small SPIFFS areas (64K), or which have a large static
set of files covering the majority of flash coupled with a frequently
updated set of other files, it may not perform as well.

Simply replace SPIFFS.begin() with LittleFS.begin() in your sketch,
use LittleFS.open in place of SPIFFS.open to open files, and everything
else just works thanks to the magic of @igrr's File base class.

**LITTLEFS FLASH LAYOUT IS INCOMPATIBLE WITH SPIFFS**
Since it is a completely different filesystem, you will need to reformat
your flash (and lose any data therein) to use it. Tools to build the
flash filesystem and upload are at
https://github.com/earlephilhower/arduino-esp8266littlefs-plugin and
https://github.com/earlephilhower/mklittlefs/ .  The mklittlefs tool
is installed as part of the Arduino platform installation, automatically.

The included example shows a contrived read-mostly example and
demonstrates how the same calls work on either SPIFFS.* or LittleFS.*
Host tests are also included as part of CI.

Directories are fully supported in LittleFS. This means that LittleFS
will have a slight difference vs. SPIFFS when you use
LittleFS.openDir()/Dir.next().  On SPIFFS dir.next()
will return all filesystem entries, including ones in "subdirs"
(because in SPIFFS there are no subdirs and "/" is the same as any
other character in a filename).

On LittleFS, dir.next() will only return entries in the directory
specified, not subdirs.  So to list files in "/subdir/..." you need
to actually openDir("/subdir") and use Dir.next() to parse through
just those elements.  The returned filenames also only have the
filename returned, not full paths.  So on a FS with "/a/1", "/a/2"
when you do openDir("/a"); dir.next().getName(); you get "1" and "2"
and not "/a/1" and "/a/2" like in SPIFFS.  This is consistent with
POSIX ideas about reading directories and more natural for a FS.

Most code will not be affected by this, but if you depend on
openDir/Dir.next() you need to be aware of it.

Corresponding ::mkdir, ::rmdir, ::isDirectory, ::isFile,
::openNextFile, and ::rewind methods added to Filesystem objects.
Documentation has been updated with this and other LittleFS information.

Subdirectories are made silently when they do not exist when you
try and create a file in a subdir.  They are silently removed when
the last file in them is deleted.  This is consistent with what
SPIFFS does but is obviously not normal POSIX behavior.  Since there
has never been a "FS.mkdir()" method this is the only way to be
compatible with legacy SPIFFS code.

SPIFFS code has been refactored to pull out common flash_hal_* ops
and placed in its own namespace, like LittleFS.

* Fix up merge blank line issue

* Merge in the FSConfig changs from SDFS PR

Enable setConfig for LittleFS as well plys merge the SPIFFS changes
done in the SDFS PR.

* Fix merge errors

* Update to use v2-alpha branch

The V2-alpha branch supports small file optimizations which can help
increase the utilization of flash when small files are prevalent.
It also adds support for metadata, which means we can start adding
things like file creation times, if desired (not yet).

* V2 of littlefs is now in upstream/master

* Update test to support non-creation-ordered files

In a directory, the order in which "readNextFile()" will return a name
is undefined.  SPIFFS may return it in order, but LittleFS does not as
of V2.  Update the test to look for files by name when doing
readNextFile() testing.

* Fix LittleFS.truncate implementation

* Fix SDFS tests

SDFS, SPIFFS, and LittleFS now all share the same common set of tests,
greatly increasing the SDFS test coverage.

* Update to point to mklittlefs v2

Upgrade mklittlefs to V2 format support

* Remove extra FS::write(const char *s) method

This was removed in #5861 and erroneously re-introduced here.

* Minimize spurious differences from master

* Dramatically reduce memory usage

Reduce the program and read chunk sizes which impacts performance
minimally but reduces per-file RAM usage of 16KB to <1KB.

* Add @d-a-v's host emulation for LittleFS

* Fix SW Serial library version

* Fix free space reporting

Thanks to @TD-er for discovering the issue

* Update littlefs to latest upstream

* Remove sdfat version included by accident

* Update SDFAT to include MOCK changes required

* Update to include SD.h test of file append
2019-05-25 09:53:24 +02:00
Earle F. Philhower, III
0bd36bf02b
Back to 2.6.0-dev (#6122)
2.5.2 release completed, time for 2.6.0 work
2019-05-20 14:06:05 -07:00
Earle F. Philhower, III
501022404f
Minor README fix (#6098)
Fix Linux location typos (lowercase "arduino" and missing "/").

Fixes #6093
2019-05-15 08:38:53 -07:00
david gauchard
d65de4aa95 back to 2.6.0-dev (#6072)
* back to dev

* emergency procedure

* per review

* 2.6.0-dev per review
2019-05-11 20:28:09 -04:00
Earle F. Philhower, III
93ef9e7005
Upgrade to https: serving for JSON, links in docs (#5992)
* Upgrade to https: serving for JSON, links in docs

Fixes #5480

* Update boards.rst documentation

* Update more documentation http: refs to https:

* Remove obsolete staging info

* Drop obsolete versions from JSON programatically

After the final merge is done on the JSON, strip out any named versions
from the final product.

Removing 1.6.5-* and 2.5.0-beta(1,2,3) for now.

* Remove 2.4.0-rc(0/1) from JSON, too
2019-04-30 23:55:03 -07:00
Juppit
b270f4907c include submodules with git clone --recursive (#5882)
* include submodules
You may also need to run this update recursively ('git submodule update --init --recursive').
2019-03-21 15:48:23 +01:00
Develo
24fa59df4b
Update README.md (#5732)
Version bumps, addition of espsoftwareserial to credits, minor text updates
2019-02-06 22:03:54 -03:00
Develo
574a121fa6
Update README.md (#5517)
Version bumps to beta2
2018-12-17 15:00:55 -03:00
Develo
20f07ecc31
Version bumps (#5479)
* bump platform.txt back to 2.5.0-dev

* bump README.md to 2.5.0-beta1
2018-12-12 00:42:46 -03:00
david gauchard
2486405e52 documentation: add quick links (#5391)
* doc: quick links

* ditto
2018-11-29 11:50:03 -08:00
Adrian Scillato
464bdccf41 Fix Readme Link (#5215) 2018-10-06 16:06:18 -07:00
Earle F. Philhower, III
b21619c172 Add BearSSL license info to README.md (#5211) 2018-10-06 13:37:53 -03:00
Develo
2f6a25b9f5
Revert "Wrong directory for installation??" (#5199)
* Revert "Make softAP documentation state the correct min value (0) for the max_connection argument. (#5165)"

This reverts commit 24a1d22730685e20c7f506574d28c90af567c439.

* Revert "Wrong directory for installation?? (#5163)"

This reverts commit d547c4766780f5a9af4a6cbda42cab790de745bc.

* Update README.md

Specify Linux dir for using git
2018-10-02 12:22:34 -03:00
teo1978
d547c47667 Wrong directory for installation?? (#5163)
PLEASE REVIEW, I'm not completely  sure, but on Linux there's no `hardware` directory inside `Java`, and it doesn't seem to make sense that there should be on MacOS. There is, instead, a `hardware` directory in the parent.
2018-10-01 12:36:58 -03:00
Ivan Grokhotkov
bb28d4a392 Release 2.4.2 2018-08-03 09:54:08 +03:00
david gauchard
144152ce6b update git+macos installation instructions (#4753) 2018-05-24 22:45:02 -04:00
Thomas Zahari
83ab03436f Update README.md (#4730)
Clarify the folder of the git installation method for Mac
2018-05-18 13:35:10 +02:00
Ivan Grokhotkov
614f7c32e5 Release 2.4.1 2018-03-08 11:49:56 +08:00
Ivan Kravets
e3074e9575
Update integration with @PlatformIO 2018-02-05 12:53:02 +02:00
Ivan Grokhotkov
06f21f28b4 bump version number 2018-01-02 07:37:22 +08:00
R P Herrold
c730c0f10c patch for #3462 2017-08-07 19:04:35 +03:00
Ivan Grokhotkov
f3be2cd081 Update readme 2017-05-15 17:14:33 +08:00
Ivan Grokhotkov
a3a7e87df7 ci: build and upload releases on Travis 2017-05-15 03:49:21 -05:00
Karl Palsson
0f50fc01d1 readme: update target milestones (#2692)
Signed-off-by: Karl Palsson <karlp@tweak.net.au>
2017-05-08 06:20:17 -05:00
Ivan Grokhotkov
a01638f3b5 readme: mention axTLS library
fixes https://github.com/esp8266/Arduino/issues/3038
2017-03-13 15:35:06 +08:00
themindfactory
f30c03b9e1 many users have asked to mention this earlier
I know it was in the body, but so many users have had questions and found esp8266.com late in their searches for answers.... really don't know, just making people happy....
2017-02-14 20:45:30 -05:00
Ivan Kravets
90729ea50c Update @PlatformIO links 2017-01-31 11:00:26 +03:00
Ivan Kravets
be3727c71f Use stable documentation of PlatformIO (#2337) 2016-08-01 11:45:05 +08:00
Krzysztof
9cc2bab276 Initial release of FAQ / Troubleshooting section (#2207)
* FAQ / Troubleshooting Final Draft release

readme.md
a01-espcomm_sync failed.md
a02-my-esp-crashes.md
a03-library-does-not-work.md
Total of five FAQ items
Emoji included
pictures folder

May need to read again in couple of days for another cleaning

Date:      Sun Jun 26 18:43:51 2016 +0200

* Frizing schematics added
2016-06-30 15:04:24 +08:00
Ivan Grokhotkov
d28c551bd2 Update documentation links 2016-06-23 15:45:49 +08:00
Ivan Grokhotkov
b7c23c79de Update documentation links 2016-04-18 12:05:56 +03:00
Ivan Grokhotkov
bb6552aa19 Update README.md to mention Arduino 1.6.8 2016-03-13 02:40:25 +03:00
Ivan Grokhotkov
46bd4fcc07 Merge pull request #1726 from ivankravets/master
Keep only main information about @PlatformIO
2016-03-10 12:54:54 +03:00
krzychb
3f1ecb425a Merge branch 'master' into master 2016-03-10 07:18:06 +01:00
krzychb
da6442a60d Changed ota_updates.md to readme.md
This is to make it's contents visible when browsing ota_updates
directory
2016-03-09 20:45:24 +01:00
themindfactory
e787af092f Update README.md
added link to esp8266.com for support
2016-03-09 12:05:58 -05:00
Ivan Kravets
13ecc1f8a7 Add using stage version in "Advanced" 2016-03-08 17:52:57 +02:00
Ivan Kravets
7e88d6a913 Add Quick Start links for PlatformIO IDE & CLI 2016-03-08 17:48:43 +02:00
Ivan Kravets
e1dc9125c3 Keep only main information about @PlatformIO 2016-03-05 19:58:51 +02:00
Ivan Grokhotkov
b265ea0a98 Update README.md 2016-03-03 19:04:31 +03:00
Ivan Grokhotkov
2d34c1b7d6 Update README.md 2016-03-01 12:16:49 +03:00
Ivan Grokhotkov
040491052e Update stable package link 2016-02-27 11:33:06 +03:00
Peter Lerup
9ef2843f8d Reference to the esp8266/Arduino makefile added 2016-02-11 22:04:57 +01:00
Ivan Grokhotkov
339140c756 Use umm_malloc for heap management 2016-02-04 13:14:47 +03:00
Ivan Grokhotkov
bc82547ddd Update staging package docs link 2016-01-24 22:44:47 +03:00
Ivan Grokhotkov
a995643e7d Update Readme 2016-01-04 18:36:03 +03:00
Ivan Kravets
79a4b922fa Add "Contents" block 2015-12-15 20:38:31 +02:00
Ivan Grokhotkov
7cb2cb5f8d Fix typo 2015-12-13 00:17:30 +03:00
Ivan Grokhotkov
124855945c Move PlatformIO instructions to a separate file 2015-12-13 00:16:01 +03:00