Sections in this page:

Introduction

ATDM utilizes Crank's Storyboard IO API for bi-directional communication with the front end UI and logic. The API provides transport delivery guarantees for messages that are placed into the queue regardless of the implementation. The maximum transport size of a message and the total queue capacity varies slightly from implementation to implementation however a 2K message size should be considered a design limit with the practical implementation limit around a 4K message payload size.

Storyboard IO communicates events over a named uni-directional channel. By default, Storyboard applications have a receive channel, named after the deployment bundle file (i.e. [bundlename].gapp). This allows backend applications to send events to the Storyboard Application. A custom receive channel can be specified in the command option for sbengine. The Storyboard application can transmit events on one or more channels. The backend software will need to open the channel and listen for events. See Storyboard IO API for more details.

Client applications can use Storyboard IO to create their own communication channels and then receive events from that channel from the Storyboard application or from any other Storyboard IO client.

CAN Generator

ATDM offers a CAN generator tool that can be configured to use a specific DBC file as well as specific output directories for the generated source code. The generator will use the configured DBC file to output C and Lua source code to the configured directories. You can access the CAN generator's repo at the following Bitbucket link here.

Generation

To use the generator, cd into the can_gateway_gen directory and run

python can_gateway_generator.py