Skip to content

Latest commit

 

History

History
122 lines (72 loc) · 2.77 KB

README.rst

File metadata and controls

122 lines (72 loc) · 2.77 KB
Raw

Sming (main)

This is the main Sming Component containing all architecture-independent code. All architecture-specific stuff is in either :component-esp8266:`sming-arch` or :component-host:`sming-arch`.

Configuration variables

Serial Communications

.. envvar:: COM_SPEED

   Default baud rate for serial port.

   This will recompile your application to use the revised baud rate.
   Note that this will change the default speed used for both flashing and serial comms.
   See also :component:`esptool` and :component:`terminal` for further details.

The default rate for serial ports is 115200 baud. You can change it like this:

make COM_SPEED=921600

Debug information log level and format

.. envvar:: DEBUG_VERBOSE_LEVEL

   When compiled in debug mode (:envvar:SMING_RELEASE undefined) there are four debug levels in increasing level of verbosity:

   * 0: errors
   * 1: warnings
   * 2: information (default)
   * 3: debug

Change it like this:

make DEBUG_VERBOSE_LEVEL=3
.. envvar:: DEBUG_PRINT_FILENAME_AND_LINE

   Set this to 1 to include the filename and line number in every line of debug output.
   This will require extra space on flash.

Note

If you change these settings and want them applied to Sming, not just your project, then you'll need to recompile all components like this:

make components-clean
make DEBUG_VERBOSE_LEVEL=3

Release builds

.. envvar:: SMING_RELEASE

   By default, this value is undefined to produce a build with debug output.
   To build for release, do this::

      make SMING_RELEASE=1

   This remains in force until you change it back::

      make SMING_RELEASE=

Localisation

.. envvar:: LOCALE

   Sming can format dates/time values based on a country code identified by this value.
   This is provided as a #define symbol for your application to use.
   See :source:`Sming/Core/SmingLocale.h` for further details.

Networking

.. envvar:: DISABLE_NETWORK

   .. note::

   0 (Default)
   1 - Remove core networking support

   Applications which do not require networking can set this flag to avoid building
   or linking the core :component:`Network` library.

   This will reduce build times, application size and RAM usage.
   Builds will not succeeded if network code has been inadvertently included.


.. envvar:: DISABLE_WIFI

   .. note::

      EXPERIMENTAL

   0 (Default)
   1 - Exclude WiFi initialisation code

   Keeps the core :component:`Network` library but excludes WiFi code.
   Applications using ethernet can use this to reduce code size. See :sample:`Basic_Ethernet`.

Components

.. toctree::
  :glob:
  :maxdepth: 1

  Components/*/index