Page Comparison

...

Files Critical to Abstraction:

• Application/config_notecard_config.h

  Provides #define variables that can be used to force override Notecard specific settings.
  

• Application/Framework/sched.h

  Declares application callback signatures and the scheduled application configuration structure, schedAppConfig.
  

• Application/Framework/sched.c

  Contains application array, implements the Sparrow task scheduler functions, and performs application callbacks (”Application Host”).
  

• Application/Gateway/auth.c

  Used by the gateway to receive/process Notes by adding additional information before forwarding to the Notecard.
  

• Application/Sensor/init.c

  Implements the weakly linked schedAppInit() function, which loads the example applications into the “Application Host”.

...

The system states used by the state machine are represented by the following constants, which have values in the set of negative integers, {x ε Z | x < 0}are all negative integers:

• STATE_UNDEFINED

• STATE_ONCE (initialization)

• STATE_ACTIVATED

• STATE_DEACTIVATED

• STATE_SENDING_REQUEST

• STATE_RECEIVING_RESPONSE

...

User-defined states are used to extend the Application Host system states for application specific purposes. These custom states are passed into the caller as a parameter to the polling callback function.

User-defined , application states MUST have values from the set of whole numbers, {x ε Z | x ≥ 0} be integers >= 0.

WARNING: Negative numbers are RESERVED for the system states and CANNOT be used for user-defined, application states.

...

WARNING: The maximum number of characters is ninety ( 90).

Dynamic Queue File Naming

...

Invoking this API causes a cascade of changes to be made to the applications runtime.

1. The current state is send to STATE_SENDING_REQUEST and if you indicated you were expecting a response, the state will change to STATE_RECEIVING_RESPONSE after sending the request.
   However, both the success and failure states are set to STATE_DEACTIVATED, which means whether your application succeeds or fails at it’s attempt to send the Note (or receive a response), it will ultimately become deactivated. If you wish to alter the success and failure states, then schedSetCompletionState() can be called promptly after noteSendToGatewayAsync() has returned.

2. If a response has been requested, then the application will continue running - blocking the main thread of execution. This, in turn, prevents other applications from running.

Note Tracking

If you have requested a response, then an arbitrary number can be added to the id tag of the Note, which allows you to match the response with the original request. When "id" is supplied to a Note, then the response (which comes as the rsp parameter of diagResponse() callback) will contain a matching "id" tag.

...

To add an application to the Sparrow firmware, you will be able to do everything from the sparrow-application folder by following these steps:

1. Create a new folder for your application in the sparrow-application folder.

2. Create an application module (.c/.h files) in your new folder.

   Multiple working examples exist, each in their own folder, listed under the sparrow-application folder.

3. Update sparrow-application/CMakeLists.txt to build your source file (.c) and include your header (.h)

   Each of the samples is also built by this CMakeLists.txt file.

Collecting Logs

Use an STLINK-V3MINI to connect to your device, you can use a terminal emulator to view the debugging output on the serial port that appears on your computer.

...

Sparrow Rail Pinout (v1.1)

NOTE: The serial connection MUST be set to operate at 9600 (8-N-1).

Sparrow Rail Pinout

Link to Sparrow MCU Datasheet (PDF)

[DEPRECATED] v1.0 Hardware

Collecting Logs

...

FTDI

...

Pin Mapping

...

Sparrow FTDI Cable Color

...

GND

...

GND

...

BLACK

...

LPRX

...

TXD

...

ORANGE

...

LPTX

...

RXD

...

YELLOW

Link to Sparrow MCU Datasheet (PDF)