OVMS3-idf/docs/en/api-reference/storage/index.rst

Storage API
***********

.. toctree::
   :maxdepth: 1

   SPI Flash and Partition APIs <spi_flash>
   SD/SDIO/MMC Driver <sdmmc>
   Non-Volatile Storage <nvs_flash>
   NVS Partition Generation Utility <nvs_partition_gen.rst>
   Virtual Filesystem <vfs>
   FAT Filesystem <fatfs>
   Wear Levelling <wear-levelling>
   SPIFFS Filesystem <spiffs>
   Mass Manufacturing Utility <mass_mfg.rst>


Example code for this API section is provided in :example:`storage` directory of ESP-IDF examples.
Moved api documentation to new folders / categories 2017-01-16 22:08:35 +00:00			`Storage API`
			`***********`

			`.. toctree::`
			`:maxdepth: 1`

			`SPI Flash and Partition APIs <spi_flash>`
docs: update SDMMC and SDSPI documentation - Split SDMMC page into pages about SDMMC/SDSPI hosts and a page about the protocol layer. - Use autogenerated API reference instead of manually generated one. - Add information about SDIO APIs. 2018-03-06 10:03:53 +00:00			`SD/SDIO/MMC Driver <sdmmc>`
Moved api documentation to new folders / categories 2017-01-16 22:08:35 +00:00			`Non-Volatile Storage <nvs_flash>`
nvs_flash: Add binary creation support for NVS partition. Ideally suited for generating a binary externally, containing key-value pairs specific to device manufacturers. Utility allows creation of a binary, compatible with NVS structure, which can be separately flashed onto a new partition. This helps device manufacturers set different values for different devices, e.g. serial numbers, but using a single firmaware image. 2018-04-19 00:18:05 +00:00			`NVS Partition Generation Utility <nvs_partition_gen.rst>`
Moved api documentation to new folders / categories 2017-01-16 22:08:35 +00:00			`Virtual Filesystem <vfs>`
			`FAT Filesystem <fatfs>`
add wear_levelling component and example 2017-04-10 14:06:35 +00:00			`Wear Levelling <wear-levelling>`
Add SPIFFS Component to IDF 2017-09-07 14:37:59 +00:00			`SPIFFS Filesystem <spiffs>`
Add files and docs for mass mfg 2018-07-17 08:44:30 +00:00			`Mass Manufacturing Utility <mass_mfg.rst>`
Moved api documentation to new folders / categories 2017-01-16 22:08:35 +00:00
Added links from api category TOC to example category folders Typo fix in bluetooth README.md 2017-01-18 20:04:11 +00:00
docs: use custom roles to generate GitHub links This change replaces direct links to GitHub master branch with auto-generated links using docutils custom roles. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. This is needed to ensure that links don’t become broken when files in master branch are moved around or deleted. The following roles are introduced: - :idf:`path` - points to directory inside ESP-IDF - :idf_blob:`path` - points to file inside ESP-IDF - :idf_raw:`path` - points to raw view of the file inside ESP-IDF - :component:`path` - points to directory inside ESP-IDF components dir - :component_blob:`path` - points to file inside ESP-IDF components dir - :component_raw:`path` - points to raw view of the file inside ESP-IDF components dir - :example:`path` - points to directory inside ESP-IDF examples dir - :example_blob:`path` - points to file inside ESP-IDF examples dir - :example_raw:`path` - points to raw view of the file inside ESP-IDF examples dir A check is added to the CI build script, which searches RST files for presence of hard-coded links (identified by tree/master, blob/master, or raw/master part of the URL). This check can be run manually: cd docs && make gh-linkcheck Additionally, Sphinx linkcheck build type is used to create new CI test, which check for broken links. This test has to be triggered explicitly, because including it in normal build process (when the commit is not yet deployed to Github) will not work. It can be triggered in a regular fashion using a combination of cron and Curl, similar to stress tests. 2017-01-19 08:16:06 +00:00			Example code for this API section is provided in :example:`storage` directory of ESP-IDF examples.