Repository files navigation

EnOcean’s IzoT ShortStack Software Development Kit (SDK) enables anyproduct that contains a microprocessor or microcontroller to quickly and inexpensively become a networked and Internet connected smart device. The ShortStack Micro Server provides a simple way to add LON/IP and native LON networking to new or existing smart devices. The IzoT ShortStack SDK is easy to use due to a simple host API, a simple driver, a simple hardware interface, a small host memory footprint, and comprehensive tool support. Documentation is available athttps://edgedocs.enocean.com.

Clone this repository, then review the installation instructions available athttps://edgedocs.enocean.com.

Revision history is maintained within the GIT database. Stable releasesare tagged asvM.NN, whereM andN are the mmajor and minorversion numbers, respectively.

The first release of IzoT ShortStack to be hosted with github.com is version4.30, so the first stable release is taggedv4.30.

Revisions between stable releases should be considered experimental or underdevelopment.

Theshortstack repository is organized into the followingdirectories:

apicontains the ShortStack host API and related source code. You need to adaptthis code to your compiler toolchain with definitions withinLonPlatform.hand port the API source code to be compiled and linked with your application.

bincontains binary utilities and installers, including Windows Installers fortheIzoT Interface Interpreter (iii) and theIzoT Resource Editor.

doccontains further documentation.

microservercontains two subfolders,microserver/standard andmicroserver/custom.

microserver/standardcontains a set of pre-build standard Micro Server images for use with thecurrent edition of IzoT ShortStack. Standard Micro Servers are designed foruse with most typical hardware configurations for a variety of common NeuronChips and Smart Transceivers.

microserver/customcontains a set of pre-build Neuron C libraries and a number of source files.You can use these source files and libraries to construct custom Micro Serverimages to support requirements not met by any of the standard Micro Servers.Note that construction of custom ShortStack Micro Servers requires that youhave a licensed copy of Echelon IzoT NodeBuilder installed.

microserver/firmwarecontains updated Neuron firmware for use with some Neuron Chips or Smart Transceivers. Please see the README.md file within for detailed insstructions.

examplecontains a set of examples for a number of applications and targets. Eachexample includes example-specific documentation. The examples are configured toreference other files within the root of this repository, such as filescontained in theapi ormicroserver/standard directories.

example/rpi/simplecontains a very simple example application with a complete API port and exampledriver for use with the Raspberry Pi mini-computer and the Raspbian Linux operatingsystem (or a compatible platform).

example/rpi/simple-isicontains a simple example application to demonstrate the use of the Interoperable Self-Installation API (ISI) for use with the Raspberry Pi mini-computer and the Raspbian Linux operating system (or a compatible platform).

example/rpi/riscontains an example for an application implementing runtime interface selection for use with the Raspberry Pi mini-computer and the Raspbian Linux operating system (or a compatible platform).

example/rpi/propertiescontains an example for an application which implements properties in property files. The example also demonstrates the initialization of complex property types, and demonstrates the use of properties for a configurable value range limitation.

To report bugs or send feedback, open a Support Ticket athttp://www.echelon.com/support.

Use of this code is subject to your compliance with the terms of theAdesto IzoT ShortStack Software Developer's Kit License Agreement which isavailable in theLICENSE.md file in yourshortstack directory.

Copyright © 2002-2022 EnOcean GmbH. EnOcean, LON, the EnOcean logo, LonWorks, LonTalk, LNS, i.LON, ShortStack, LonMaker, IzoT, LonLink, OpenLDV, LonScanner, and LonBridge are trademarks of EnOcean GmbH that may be registered in the United States and other countries. For a complete list of registered trademarks seewww.enocean.com. All rights reserved.