@mchp-mcc/data-streamer-driver

Data Streamer Protocol Driver

Overview

The Data Streamer Protocol allows you to send multiple variables from your embedded application, to display these variables on a graph (or custom dashboard).

Features

• Selectable UART Dependency
  • This allows to select the UART over which you would like to send Data Streamer frames.
  • If you are using a development kit, this will typically be the UART connected to the Serial/ CDC port.
• Add Variables and Configure its type
  • You may add variables as many as you like.
    • You may add by Clicking the "+" icon beside the existing variables. This adds new variable above the existing one.
    • You may add by Clicking the "+" icon at the bottom. This adds new variable at the bottom of the variable list.
  • You may remove existing variables as well.
    • This is done by clicking the 'trash bin' icon beside the variable to be removed.
  • For each variable, you can configure its type from the list of allowed variable types.
  • For each variable, you can configure and give it a name. The variable name should be valid in C Language.
  • For each variable, you can configure its type from the list of allowed variable types.
• Configurable API Prefix. API Prefix should be valid in C Language
• Generates the Data Streamer APIs
  • Sends stream of variables to be displayed
• Generates ds Configuration file
  • When opened with Data Visualizer, this will show list of configured variables

References

Open the links below for more information:

• Data Streamer User Guide
• MPLAB Data Visualizer Guide
• Data Stream Protocol

Changelog

All notable changes to this project will be documented in this file.

[2.0.1] - 2024-07-30

New Features

• CC8SCRIP-20438 :- dsPIC33A device support for Data Streamer Driver

[2.0.0] - 2024-02-15

New Features

• CC8SCRIP-17509 :- Add Analytics Support for the Data Streamer Library
• CC8SCRIP-15287 :- Data streamer support for dsPIC device family

Improvements

• CC8SCRIP-19366 :- Refactor Data Streamer API implementation to use UART driver Interface
• CC8SCRIP-12983 :- Data Streamer to explicitly request 115200 baudrate to UART PLIB

[1.3.0] - 2022-09-14

New Features

• CC8SCRIP-8572 :- Refactor Data Streamer to the latest UART interface
• CC8SCRIP-7135 :- Upgrade Data Streamer Library to handle pointers

Bug Fixes

• CC8SCRIP-9381 :- Missing Data Visualizer from Library Tab in Device Resources
• CC8SCRIP-7846 :- Data Streamer driver libraries(PIC16F17146): Unable to send multiple data
• CC8SCRIP-7828 :- Code generated for Data Streamer will not work.
• CC8SCRIP-7827 :- Data Streamer and UART3PLIB invoke warning about Parity and DataSize
• CC8SCRIP-4708 :- "DataVisualizer_SendFrame" does not clear TX Complete at the start, nor waits for TxReady before sending the START and END bytes
• CC8SCRIP-4403 :- tinyAVR 2: Data Streamer driver issues
• CC8SCRIP-3104 :- AVR DB Data Streamer Driver - wrong sequence of USARTn list