1 Data Visualizer Run Time (DVRT) Library Overview

This file contains the API prototypes for the dvruntime driver module.

• DVRT_StreamUpdates_t stream

• DVRT_VariableUpdate_t Var

• DVRT_StreamIntervalUpdate_t interval

• DVRT_CommandTemplate_t generic

• uint8_t DVCmdArray [sizeof(DVRT_StreamUpdates_t)]

The documentation for this union was generated from the following file:

source/

DVRunTime.c

Typedef for struct containing the elements needed for a generic DVRT command.  

#include <DVRunTime_types.h>

The documentation for this struct was generated from the following file:

source/

DVRunTime_types.h

Structure containing the function pointers to the DV Run Time driver APIs.

Section: Included Files Selecion: Data Type Definitions

#include <DVRunTime_interface.h>

The documentation for this struct was generated from the following file:

source/

DVRunTime_interface.h

Defines the data structure for updating the streaming period of frames sent from the DVRT to the Data Visualizer.

#include <DVRunTime_types.h>

The documentation for this struct was generated from the following file:

source/

DVRunTime_types.h

Defines the data structure for updating the stream of variables sent to the Data Visualizer.

#include <DVRunTime_types.h>

The documentation for this struct was generated from the following file:

source/

DVRunTime_types.h

Defines one entry of the Variable Pointer Table.

Defines one entry of the Variable Pointer Table.

#include <DVRunTime_types.h>

The documentation for this struct was generated from the following file:

source/

DVRunTime_types.h

Defines the data structure needed to update the Variable Pointer Table (DVPMT).

#include <DVRunTime_types.h>

The documentation for this struct was generated from the following file:

source/

DVRunTime_types.h

• unsigned streamOn: 1

• unsigned osr: 1

• unsigned ping: 1

The documentation for this struct was generated from the following file:

source/

DVRunTime.c

• union DVCmds

• struct flagS

• void DVRT_UART_RX_CallBack (void)

• void DVRT_HandleCommand (void)

• void DVRT_UART_WriteByte (uint8_t txData)

  This blocking function writes a byte of data to the selected UART.

• void DVRT_WritePacket (void)

• void DVRT_Error_Callback (void)

• void DVRT_Initialize (void)

  Initializes the DVRT driver. Sets the variable values to their initial values and registers error callback functions for UART errors.

• void DVRT_Process (void)

  Processes the DVRT driver. Checks the UART for incoming data and processes the data if it is available. It also checks for time-out conditions and triggers the periodic sending of data, if required. Finally, it executes one-shot readings and ping commands.

• const uart_drv_interface_t * UART_DV = &UART3

• static const struct TIMER_INTERFACE * TIMER_DVRT = &Timer0

• static DVRT_error_t error

• const DVRT_interface_t DVRT

  Declaration of the DVRT interface and its function pointers.

• static DVRT_VariablePointerTableEntry_t DVPMT [DYNAMIC_VAR_PTR_COUNT]

• static volatile union DVCmds DVRT_ReceivedCmd

• static const volatile uint16_t dvIdFw = DV_FW_CODE

• static volatile uint8_t rxBufPtr

• static volatile uint8_t DVFrameCounter

• static uint16_t DVStreamInterval

• static uint16_t DVStreamInterval_Counter

• static uint16_t DVCmdInterval

• static uint16_t DVCmdInterval_Counter

• static size_t USART_Error

• static struct flagS DVflag

This file contains the driver implementation for the dvruntime driver module.

dvruntime Generated Driver Source File

• void DVRT_Initialize (void)

  Initializes the DVRT driver. Sets the variable values to their initial values and registers error callback functions for UART errors.

• void DVRT_Process (void)

  Processes the DVRT driver. Checks the UART for incoming data and processes the data if it is available. It also checks for time-out conditions and triggers the periodic sending of data, if required. Finally, it executes one-shot readings and ping commands.

• #define EXTERN extern

• const DVRT_interface_t DVRT

  Declaration of the DVRT interface and its function pointers.

dvruntime Generated Driver Header File

• #define DYNAMIC_VAR_PTR_COUNT 8U /* Number of Dynamic Variables Pointers in the Monitor Table */

• #define DV_STREAM_TIME 20U /* Streaming time interval (time dependent on main loop tick) */

• #define DV_RX_CMD_TIMEOUT 200U /* Command timeout: Timeout after number of times DVRT_process() is called */

• #define DV_FW_CODE (uint16_t)261 /* Project Firmware Code */

• #define DV_START_OF_FRAME 0x03U /* Start Frame Byte */

• #define DV_END_OF_FRAME 0xFCU /* End Frame Byte */

• #define DV_RX_CMD_MIN_SIZE 3U /* Minimun number of byte in a RX command */

This file contains the macros for the configuration of the dvruntime module.

dvruntime Generated Configuration Header File

• struct DVRT_interface_t

  Structure containing the function pointers to the DV Run Time driver APIs.

Contains the function pointers to the DV Run Time library component.

dvruntime Generated Interface Header File

• struct DVRT_VariablePointerTableEntry

  Defines one entry of the Variable Pointer Table.

• struct DVRT_StreamUpdates

  Defines the data structure for updating the stream of variables sent to the Data Visualizer.

• struct DVRT_VariableUpdate

  Defines the data structure needed to update the Variable Pointer Table (DVPMT).

• struct DVRT_StreamIntervalUpdate

  Defines the data structure for updating the streaming period of frames sent from the DVRT to the Data Visualizer.

• struct DVRT_CommandTemplate

  Typedef for struct containing the elements needed for a generic DVRT command.  

• typedef struct DVRT_VariablePointerTableEntry DVRT_VariablePointerTableEntry_t

• typedef struct DVRT_StreamUpdates DVRT_StreamUpdates_t

• typedef struct DVRT_VariableUpdate DVRT_VariableUpdate_t

• typedef struct DVRT_StreamIntervalUpdate DVRT_StreamIntervalUpdate_t

• typedef struct DVRT_CommandTemplate DVRT_CommandTemplate_t

• typedef size_t DVRT_error_t

• enum { UPDATE_VARIABLE_POINTER_TABLE = 0, UPDATE_VARIABLE_VALUE = 1, UPDATE_STREAMING_TICK = 2, TURN_STREAMING_OFF = 3, TURN_STREAMING_ON = 4, ONE_SHOT_READ = 5, PING = 6 }

This file contains the data types used for the operation of the dvruntime module.

dvruntime Generated Types Header File

The use cases show example uses of the Data Visualizer Run Time feature, within an MCC Melody Project.

Add the following components and configure them as described in the specific example. Note: Fairly high system clock is required, but this can be lowered once done with the debugging/verification of application functionality with the DVRT.

After configuring the components as described above click Generate to generate the code. Then add the following code snippets to your application:

/* Include for PIC16F/18F and AVR*/
#include "mcc_generated_files/system/system.h"

/* Includes for dsPIC and PIC24*/
#include "mcc_generated_files/system/system.h"
#include "mcc_generated_files/system/pins.h"
#include "mcc_generated_files/DVRT/DVRunTime.h"
#include "mcc_generated_files/timer/sccp1.h"   /* Replace with appropriate header from: .../timer/timerX.h */  
#include "mcc_generated_files/timer/sccp2.h"   /* Replace with appropriate header from: .../timer/timerX.h */  
#include <stdbool.h>

static volatile bool     LED_ON = false;
static volatile uint16_t LED_period_ms = 250U;
static volatile uint16_t Count_msTicksSinceToggle = 0U;

void Timer_Callback_1ms(void){
    Count_msTicksSinceToggle++;
    if(Count_msTicksSinceToggle >= LED_period_ms){
        LED_ON = !LED_ON;    // Toggle LED state variable
        IO_LED_Toggle();
        Count_msTicksSinceToggle = 0U;
    }
}

int main(void)
{
    SYSTEM_Initialize();
    INTERRUPT_GlobalInterruptEnable();   /* For PIC18F */
    /* Comment out for AVR: Enable Global IRQ in Interrupt Manager */
    /* Comment out for dsPIC, Global IRQs are enabled by default */
    
    /* Replace X with number of 2nd timer added */ 
    /* From name of const struct TIMER_INTERFACE, path: mcc_generated_files\timer\src\timerX.c */
    TimerX.TimeoutCallbackRegister(Timer_Callback_1ms); 

    while(1)
    {
    }    
}