VSCP L1 Framework

The VSCP software framework for level 1 devices provides several layers according to the VSCP specification.

VSCP L1 Framework
VSCP
Framework
VSCP L1 Bootloader
VSCP CLI Tools
Structure
Getting Started
Typical Infrastructure
Issues, Ideas And Bugs
License
Contribution

VSCP

Logo

The Very Simple Control Protocol (VSCP), an open and free protocol for IoT/m2m automation tasks.

More information can be found on the main site http://www.vscp.org

Framework

Core

core-diagram

The core functionality which has a built-in state machine to handle different use cases of the protocol and etc. (vscp_core.[ch]). Right now it supports every mandatory event and some minor optional ones.
The decision matrix is handled separately (vscp_dm.[ch]). It contains the standard decision matrix, as described in the VSCP specification and contains an additional extension.
The decision matrix next generation is supported too (vscp_dm_ng.[ch]). It eliminates the limitations of the standard decision matrix, incl. its extension.
VSCP needs some mandatory persistent data, which can be modified during run time. This kind of data is in the persistent storage handled (vscp_ps.[ch]).
The device specific data is handled separatly (vscp_dev_data.[ch]). You can decide whether this data shall be constant and configured during compile time or its loaded from persistent storage and could be modified during run time.
The transport layer has the possibility to loop events back (vscp_transport.[ch]).
This can be configured for each data (vscp_dev_data_config.[ch]), except the firmware version.
Functionality can be configured for your needs (vscp_config.[ch]).
Some utility functions are separated (vscp_util.[ch]) and used by different core modules or are maybe interested for the application too.
Log functionaly is provided for debugging purposes (vscp_logger.[ch]).

The framework is independent of the hardware and the used operating system. To achieve independence all of the following
layers have to be adapted to the system. This is supported by templates, which contains all necessary functions with nearly empty
bodys.

The following modules have to be adapted for your needs, because it depends on the hardware, the operating system or
how VSCP is integrated into your software:

Transport adapter (vscp_tp_adapter.c)
Timer driver (vscp_timer.c)
Persistent memory access driver (vscp_ps_access.c)
Action module, used by the decision matrix (standard, extension and next generation) (vscp_action.c)
Application register access (vscp_app_reg.c)
Callout functions, lamp handling and etc. (vscp_portable.c)

Templates exists for all of them, which makes it much easier to adapt it and less time. See in the templates folder.

Event Abstraction

core-diagram

Using only the core, you have to assemble the VSCP events by yourself. If you want to deal only with parameter, which are
VSCP independent, use the next upper layer, the event abstraction modules.

Configuration Parameters

Common

The following configuration parameters can be enable/disable/set in the

vscp_config_overwrite.h

Feature switch	Default	Description
_{VSCP_CONFIG_ENABLE_LOGGER}	_disabled	_{Enable log functionality (CLASS1.Log). Use the macros in vscp_logger.h to send log messages.}
_{VSCP_CONFIG_SILENT_NODE}	_disabled	_{Silent node configuration, which is used for e. g. RS-485 connections. This type of nodes only listen to traffic before they get initialized by a host. In this case the nickname discovery process is not started for a node when it is powered up for the first time. This type on node instead starts to listen for the CLASS1.PROTOCOL, Type=23 (GUID drop nickname-ID / reset device.) event. When this series of events is received and the GUID is the same as for the module the module starts the nickname discovery procedure as of above.}
_{VSCP_CONFIG_HARD_CODED_NODE}	_disabled	_{Hard-coded node (fixed nickname id)}
_{VSCP_CONFIG_HEARTBEAT_SUPPORT_SEGMENT}	_disabled	_{Enable segment controller heartbeat support for nodes.}
_{VSCP_CONFIG_HEARTBEAT_NODE}	_enabled	_{Enable sending node heartbeat (mandatory since 2015-09-10).}
_{VSCP_CONFIG_IDLE_CALLOUT}	_disabled	_{Enable idle callout. If VSCP stops working and enters idle state, the application will be notified.}
_{VSCP_CONFIG_ERROR_CALLOUT}	_disabled	_{Enable error callout. If VSCP stops working and enters error state, the application will be notified.}
_{VSCP_CONFIG_BOOT_LOADER_SUPPORTED}	_disabled	_{Enable boot loader support.}
_{VSCP_CONFIG_ENABLE_DM}	_enabled	_{Enable decision matrix (standard).}
_{VSCP_CONFIG_DM_PAGED_FEATURE}	_disabled	_{Enable decision matrix special paged feature.}
_{VSCP_CONFIG_ENABLE_DM_EXTENSION}	_disabled	_{Enable the decision matrix extension to be able to compare to a configureable zone/sub-zone and event parameters.}
_{VSCP_CONFIG_ENABLE_DM_NEXT_GENERATION}	_disabled	_{Enable the decision matrix next generation.}
_{VSCP_CONFIG_ENABLE_LOOPBACK}	_disabled	_{Enable a loopback for all sent VSCP events. This feature is interesting to invoke decision matrix actions by own sent VSCP events.}
_{VSCP_CONFIG_ENABLE_SEGMENT_TIME_CALLOUT}	_disabled	_{Enable a time update callout for every received segment master heartbeat, in case the event contains a new time since epoch.}
_{VSCP_CONFIG_PROTOCOL_EVENT_NOTIFICATION}	_disabled	_{Usually the core handles all protocol class events and they are not forwarded to the application. Enable this to forward the events as well. If application handles the event, the core won’t handle it. Attention: Handling events which the core is waiting for can cause bad behaviour.}
_{VSCP_CONFIG_ENABLE_CUSTOM_HEARTBEAT}	_disabled	_{By default a heartbeat is sent, with 0 as user data and without extended data. If you need a custom heartbeat and able to define user and extended data by yourself, enable this.}

Parameter	Default	Description
_{VSCP_CONFIG_NODE_SEGMENT_INIT_TIMEOUT}	₅₀₀₀	_{Timeout in ms for the node segment initialization.}
_{VSCP_CONFIG_PROBE_ACK_TIMEOUT}	₂₀₀₀	_{Timeout in ms for the probe acknowledge.}
_{VSCP_CONFIG_MULTI_MSG_TIMEOUT}	₁₀₀₀	_{Timeout in ms to observe multi-message handling.}
_{VSCP_CONFIG_HEARTBEAT_NODE_PERIOD}	₃₀₀₀₀	_{Node heartbeat period in ms (recommended 30s - 60s).}
_{VSCP_CONFIG_DM_PAGE}	₁	_{Decision matrix location: First page of the decision matrix.}
_{VSCP_CONFIG_DM_OFFSET}	₀	_{Decision matrix location: Offset in the first page of the decision matrix.}
_{VSCP_CONFIG_DM_ROWS}	₁₀	_{Number of decision matrix rows.}
_{VSCP_CONFIG_DM_NG_PAGE}	₂	_{Decision matrix next generation: Location in the application register space. Note that the dm ng always starts at the begin of the page! This design decision was just for simplification, nothing else.}
_{VSCP_CONFIG_DM_NG_RULE_SET_SIZE}	₈₀	_{Decision matrix next generation: Maximum size in bytes of a rule set.}
_{VSCP_CONFIG_LOOPBACK_STORAGE_NUM}	₄	_{Number of messages in the loopback cyclic buffer. Note, that if you want to store up to 3 events, you have to configure 4, because of the technical implementation of the cyclic buffer.}
_{VSCP_CONFIG_START_NODE_PROBE_NICKNAME}	₁	_{Number to start probing nickname from.}

Device Data

The following device data can be enable/disable/set in the

vscp_dev_data_config_overwrite.h

Feature switch	Default	Description
_{VSCP_DEV_DATA_CONFIG_ENABLE_FAMILY_CODE}	_enabled	_{Enable the support of the family code.}
_{VSCP_DEV_DATA_CONFIG_ENABLE_GUID_STORAGE_PS}	_disabled	_{Enable this define to load the GUID from persistent storage.}
_{VSCP_DEV_DATA_CONFIG_ENABLE_GUID_STORAGE_EXT}	_disabled	_{Enable this define to load the GUID from external storage, e.g. from MCU GUID.}
_{VSCP_DEV_DATA_CONFIG_ENABLE_NODE_ZONE_STORAGE_PS}	_disabled	_{Enable this define to load the node zone from persistent storage.}
_{VSCP_DEV_DATA_CONFIG_ENABLE_NODE_SUB_ZONE_STORAGE_PS}	_disabled	_{Enable this define to load the node sub-zone from persistent storage.}
_{VSCP_DEV_DATA_CONFIG_ENABLE_MANUFACTURER_DEV_ID_STORAGE_PS}	_disabled	_{Enable this define to load the manufacturer device id from persistent storage.}
_{VSCP_DEV_DATA_CONFIG_ENABLE_MANUFACTURER_SUB_DEV_ID_STORAGE_PS}	_disabled	_{Enable this define to load the manufacturer sub device id from persistent storage.}
_{VSCP_DEV_DATA_CONFIG_ENABLE_MDF_URL_STORAGE_PS}	_disabled	_{Enable this define to load the MDF URL from persistent storage.}
_{VSCP_DEV_DATA_CONFIG_ENABLE_STD_DEV_FAMILY_CODE_STORAGE_PS}	_disabled	_{Enable this define to load the standard device family code from persistent storage. Note, that the feature family code has to be enabled, otherwise this define won’t be considered.}
_{VSCP_DEV_DATA_CONFIG_ENABLE_STD_DEV_TYPE_STORAGE_PS}	_disabled	_{Enable this define to load the standard device type from persistent storage. Note, that the feature family code has to be enabled, otherwise this define won’t be considered.}

Parameter	Default	Description
_{VSCP_DEV_DATA_CONFIG_NODE_GUID}	_{00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00}	_{Node GUID}
_{VSCP_DEV_DATA_CONFIG_NODE_ZONE}	_0xff	_{Node zone. Note, 0xff means all zones.}
_{VSCP_DEV_DATA_CONFIG_NODE_SUB_ZONE}	_0xff	_{Node sub-zone. Note, 0xff means all sub zones.}
_{VSCP_DEV_DATA_CONFIG_MANUFACTURER_ID}	_0x0000	_{Manufacturer id (0x0000 means unknown)}
_{VSCP_DEV_DATA_CONFIG_MANUFACTURER_DEVICE_ID}	_0x00000000	_{Manufacturer device id}
_{VSCP_DEV_DATA_CONFIG_MANUFACTURER_SUB_DEVICE_ID}	_0x00000000	_{Manufacturer sub device id}
_{VSCP_DEV_DATA_CONFIG_MDF_URL}	_empty	_{MDF URL (only 32 characters are allowed!), without “http://“ which is implied Note, the encoding is UTF-8!}
_{VSCP_DEV_DATA_CONFIG_VERSION_MAJOR}	₀	_{Major firmware version (format: major.minor.sub-minor)}
_{VSCP_DEV_DATA_CONFIG_VERSION_MINOR}	₁	_{Minor firmware version (format: major.minor.sub-minor)}
_{VSCP_DEV_DATA_CONFIG_VERSION_SUB_MINOR}	₀	_{Sub-minor firmware version (format: major.minor.sub-minor)}
_{VSCP_DEV_DATA_CONFIG_STANDARD_DEVICE_FAMILY_CODE}	_0x00000000	_{Standard device family code.}
_{VSCP_DEV_DATA_CONFIG_STANDARD_DEVICE_TYPE}	_0x00000000	_{Standard device type.}
_{VSCP_DEV_DATA_CONFIG_FIRMWARE_DEVICE_CODE}	_0x0000	_{Firmware device code.}

VSCP L1 Bootloader

A generic VSCP L1 bootloader: https://github.com/BlueAndi/vscp-bootloader

VSCP CLI Tools

Some tools to maintain VSCP via command line interface: https://github.com/BlueAndi/vscp-cli-tools

Structure

+---doc                 (Documentation)
|   +---doxfiles        (Doxygen related files)
|   \---html            (Doxygen generated documentation in HTML)
+---examples            (Examples which are showing how to use the VSCP framework)
|   +---arm             (Examples with ARM based microcontrollers)
|   \---avr             (Examples with Atmel AVR microcontrollers)
|---src                 (VSCP framework)
|   \---events          (These modules are using the VSCP core to send CLASS1 dedicated events)
+---templates           (Templates of the files, which the user shall adapt to its needs)
|---test                (Test of the VSCP framework)
\---tools               (General tools, used by examples and projects)
    \---xslt            (XML transformation processor)

Getting Started

This part shows you how to get the VSCP framework working in a “minimal” way:

1 Get The VSCP Framework To Your Project

There are 3 possible integrations listed, there may be more of course.

1.1 Possibility 1: Copy it

Copy or link the VSCP framework (./src and ./src/events) to your project.
Copy (!!do not link!!) all necessary template files (./templates) to your project. Recommended is a sub-directory “vscp_user”.
Update your makefile or your project configuration.

1.2 Possibility 2: git submodule

Initial add it.

git submodule add https://github.com/BlueAndi/vscp-framework

Later update it.

git submodule update --remote

1.3 Possibility 3: PlatformIO

Add vscp-framework with the required version to the platformio.ini configuration. Find more informations in the PlatformIO documentation.

Example:

    lib_deps =
        vscp-framework @ 2.0.0

2 Initialization Of The VSCP Framework

The VSCP framework has to be initialized, before any function is used. This is simply done
by calling the function vscp_core_init() during start-up.

3 Processing Of The VSCP Framework

The VSCP framework has to be called periodically to be able to react on incoming events.
Call the process routine vscp_core_process() in a constant cyclic period. The period should be
lower or equal than 100 ms, but depends on several factors, like the bitrate on the choosen
communication bus, the event load on the bus and etc.

The process routine handle all received VSCP events.

4 VSCP Framework Timer

VSCP specifies several timing behaviour in different use cases. Therefore the framework needs some
timers to achieve it.

Because timer are usually hardware and software dependend, they have to be implemented by you for your needs.
Adapt the vscp_timer.c template file. Find all necessary informations in the module.

The timer handling can be processed by calling vscp_timer_process() in the same or in a different task as vscp_core_process() is called.
If a different task calls it, don’t forget to make the timer functions reentrant!

Because the VSCP timer module needs to know the period of processing the timers, you have to call it with the
period time in ms as parameter, e.g. vscp_timer_process(1000);

Call the timer processing routine equal or lower than 1 s.

Note, that never call vscp_process() with a lower period, than vscp_timer_process(). Because vscp_process() reacts
on timer timeouts and vscp_timer_process() decrease only the timers, but doesn’t do more.

5 VSCP Transport Adaption

Now its time to connect the VSCP framework to the communication bus. This can be done by implementing the transport
adapter in the vscp_tp_adapter.c template file.

6 Control The VSCP Lamp

To see that something is happen on your embedded device, next step is to control the VSCP lamp (in most cases a LED).
Update the function vscp_portable_setLampState() in the vscp_portable.c module.

7 Connect The Initialization Button

According to the VSCP specification, every embedded device should have a button to start the segment initialization.
Hopefully you have one right now :-) and if it is pressed, call the function vscp_core_startNodeSegmentInit() in the
vscp_core.c module.

8 Persistent Memory

It is important that the VSCP framework can store data in a persistent memory, e.g. an EEPROM. Implement in the
vscp_ps_access.c module the low level access to the persistent memory. Its quite easy, because only byte access
functions are used, so you have one read and one write function to adapt.

9 Ready To Run

Now the minimal sub set is done and your node hopefully starts up with a nickname discovery.

Have fun!

Typical Infrastructure

typical-infrastructure

Issues, Ideas And Bugs

If you have further ideas or you found some bugs, great! Create a issue or if
you are able and willing to fix it by yourself, clone the repository and create a pull request.

License

The whole source code is published under the MIT license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any
additional terms or conditions.