2.2 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

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

• 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)

• 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 ()

  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.

• static const uart_drv_interface_t * UART = &UART2

• DVRT_error_t error

• const DVRT_interface_t DVRT

  Declaration of the DVRT interface and its function pointers.

• DVRT_VariablePointerTableEntry_t DVPMT [DYNAMIC_VAR_PTR_COUNT]

• volatile union DVCmds DVRT_ReceivedCmd

• const volatile uint16_t dvIdFw = DV_FW_CODE

• volatile uint8_t rxBufPtr

• volatile uint8_t tickCounter

• uint16_t DVStreamInterval

• uint16_t DVStreamInterval_Counter

• uint16_t DVCmdInterval

• uint16_t DVCmdInterval_Counter

• 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 8 /* Number of Dynamic Variables Pointers in the Monitor Table */

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

• #define DV_RX_CMD_TIMEOUT 200 /* 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 0x03 /* Start Frame Byte */

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

• #define DV_RX_CMD_MIN_SIZE 3 /* 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

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/tmr1.h"   /* Replace with appropriate header from: .../timer/timerX.h */  
#include <stdbool.h>

/* Replace with TMR_INTERFACE / TIMER_INTERFACE from: MCC Generated Files/timer/timerX.h */
const struct TMR_INTERFACE *Timer = &Timer0;  

volatile bool     LED_ON = false;
volatile uint16_t LED_period_ms = 250;
volatile uint8_t  msTick = 0;
volatile uint16_t Count_msTicksSinceToggle = 0;
volatile uint16_t Count_dvrtProcessCalls = 0;

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

int main(void)
{
    SYSTEM_Initialize();
    DVRT_Initialize();
    Timer->TimeoutCallbackRegister(Timer_Callback_1ms); 
        
    INTERRUPT_GlobalInterruptEnable();   
    //For Q71 INTERRUPT_GlobalInterruptHighEnable(); 
    //For AVR: Enable Global IRQ in Interrupt Manager
    //For dsPIC, Global IRQs are enabled by default

    while(1){
        if(msTick == 1){
            msTick = 0;
            Count_dvrtProcessCalls++;
            DVRT_Process();
        }
    }
}

This is the minimum you'll need to add to your own project to use DVRT. The example can be verified by watching the DVCmdInterval_Counter, which is incremented within DVRT_process().

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

/* DVRT minimum project: dsPIC, PIC24 */
#include "mcc_generated_files/system/system.h"
#include "mcc_generated_files/DVRT/DVRunTime.h"
#include "mcc_generated_files/timer/tmr1.h"   /* Replace with appropriate header from: .../timer/timerX.h */

/* Replace with TMR_INTERFACE / TIMER_INTERFACE from: MCC Generated Files/timer/timerX.h */
const struct TIMER_INTERFACE *Timer = &Timer1;

int main(void)
{
    SYSTEM_Initialize();
    DVRT_Initialize();
    Timer->TimeoutCallbackRegister(DVRT_Process);

    while(1){
        Timer->Tasks();
    }
}

/* DVRT minimum project for PIC16F/18F, coming soon for AVR */
#include "mcc_generated_files/system/system.h"
/* Replace with TMR_INTERFACE / TIMER_INTERFACE from: MCC Generated Files/timer/timerX.h */
const struct TMR_INTERFACE *Timer = &tmr0;

int main(void)
{
    SYSTEM_Initialize();
    DVRT_Initialize();
    Timer->TimeoutCallbackRegister(DVRT_Process);
    
    INTERRUPT_GlobalInterruptEnable(); 
    /*For Q71: INTERRUPT_GlobalInterruptHighEnable(); */

    while(1){
        Timer->Tasks();
    }
}