firmware-base/vendor/sming/Sming/samples/Basic_IFS
2026-01-28 16:42:43 +01:00
..
app vendor 2026-01-28 16:42:43 +01:00
files vendor 2026-01-28 16:42:43 +01:00
resource vendor 2026-01-28 16:42:43 +01:00
basic_ifs_Esp32.hw vendor 2026-01-28 16:42:43 +01:00
basic_ifs_Esp8266.hw vendor 2026-01-28 16:42:43 +01:00
basic_ifs_Host.hw vendor 2026-01-28 16:42:43 +01:00
basic_ifs_Rp2040.hw vendor 2026-01-28 16:42:43 +01:00
basic_ifs.hw vendor 2026-01-28 16:42:43 +01:00
basic_ifs.usbcfg vendor 2026-01-28 16:42:43 +01:00
component.mk vendor 2026-01-28 16:42:43 +01:00
fsimage.fwfs vendor 2026-01-28 16:42:43 +01:00
Kconfig vendor 2026-01-28 16:42:43 +01:00
Makefile vendor 2026-01-28 16:42:43 +01:00
README.rst vendor 2026-01-28 16:42:43 +01:00

Basic IFS
=========

.. highlight:: bash

Simple Webserver demonstration using IFS.

View the filesystem using a web browser.

To see directory content in a different format, append ``?format=XX``, one of:

- ``json``
- ``text``
- ``html``

Use the format ``archive`` to retrieve an archive/backup of the directory tree as an FWFS image.


Building
--------

By default, data is stored in a read-only FWFS (Firmware Filesystem) partition.

This sample also demonstrates how to store the data in a :cpp:type:`FlashString` object::

    make config-clean
    make ENABLE_FLASHSTRING_IMAGE=1

Because the data is linked into the program image this is only suitable for small filesystem images.
This could be used to store default recovery data, especially with OTA updates because each program
image is self-contained.

To add support for SD Cards to this sample::

    make ENABLE_SDCARD=1

See :library:`FatIFS` for further details of SD Card and FAT filing system support.

To add support for a USB storage device::

    make ENABLE_USB_STORAGE=1