Using the Data Recorder - Revision history

MartinW: /* Introduction */

2022-12-21T08:57:15Z

Introduction

DavidA at 08:36, 2 July 2019

2019-07-02T08:36:58Z

DanielM at 08:02, 17 May 2019

2019-05-17T08:02:37Z

DanielM at 13:39, 16 May 2019

2019-05-16T13:39:29Z

DanielM at 13:30, 16 May 2019

2019-05-16T13:30:02Z

DanielM at 13:21, 16 May 2019

2019-05-16T13:21:19Z

DanielM at 12:50, 16 May 2019

2019-05-16T12:50:13Z

DanielM at 12:17, 16 May 2019

2019-05-16T12:17:26Z

DanielM at 12:09, 16 May 2019

2019-05-16T12:09:22Z

DanielM at 10:28, 16 May 2019

2019-05-16T10:28:55Z

@@ Line 7: / Line 7: @@
 Flowcode includes a Data Recorder ideal for testing your applications in both hardware and simulation.
-It works alongside [[Ghost_Technology|Ghost Technology]] to allow users to monitor signals in real time using In-Circuit-Test. It can also be used in simulation mode, though timing of signals is not accurate when using simulation. In simulation, it allows the user to see the results and values from raw data and components such as dials and measures. This data allows you to monitor the state of the various signals plotted to various channels.
+It works alongside [[Ghost_Technology|Ghost Technology]] to allow users to monitor signals in real time using In-Circuit-Test. It can also be used in simulation mode, though timing of signals is not accurate when using simulation. In simulation, it allows the user to see the results and values from raw data and components such as dials and measures. This data allows you to monitor Variables and the state of the various signals plotted to various channels.
@@ Line 13: / Line 13: @@
 The Data Recorder is very useful for analyzing data as it can accurately display information to identify patterns in the data as well as the speed data is being displayed at. Components such as the DSP range will automatically create their own Data Recorder channels, allowing for very simple yet powerful means of monitoring and debugging the system.
 ===How to use===

← Older revision		Revision as of 08:36, 2 July 2019
Line 1:		Line 1:
−	~~<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>~~
−
−
	__TOC__		__TOC__

← Older revision		Revision as of 08:02, 17 May 2019
Line 10:		Line 10:
	Flowcode includes a Data Recorder ideal for testing your applications in both hardware and simulation.		Flowcode includes a Data Recorder ideal for testing your applications in both hardware and simulation.

−	It works alongside Ghost Technology to allow users to monitor signals in real time using In-Circuit-Test. It can also be used in simulation mode, though timing of signals is not accurate when using simulation. In simulation, it allows the user to see the results and values from raw data and components such as dials and measures. This data allows you to monitor the state of the various signals plotted to various channels.	+	It works alongside [[Ghost_Technology\|Ghost Technology]] to allow users to monitor signals in real time using In-Circuit-Test. It can also be used in simulation mode, though timing of signals is not accurate when using simulation. In simulation, it allows the user to see the results and values from raw data and components such as dials and measures. This data allows you to monitor the state of the various signals plotted to various channels.

@@ Line 171: / Line 171: @@
 ===Interacting with streams===
@@ Line 180: / Line 180: @@
 Hovering your mouse over the stream will show you the time interval between the two peaks that surround the cursor. Note that in simulation mode, this timing is not accurate.
 ===Packet Decoding===
@@ Line 191: / Line 192: @@
 Packet decoding is available for certain program streams added by components. The button for decoding becomes available when the relevant communication component is added to the panel.
 [[File:data_recorder_decode_button.png|border|600px]]
 Decoding is then done by clicking the decode stream button on the appropriate stream. Streams can be decoded regardless of whether the Data Recorder is running in simulation or Ghost mode.
 [[File:data_recorder_decoded_packets.png|border|600px]]

@@ Line 157: / Line 157: @@
-[[File:Scope11.jpg]] <!-- AddCustom call -->
+[[File:DataRecorderAddCustom.png|border|200px]]
 The data for a custom channel cannot come from a digital or analogue channel automatically. Instead we have to manually pass the data to the custom channel. This is done by using the [[API_Scope.SetCustom|SetCustom]] function call. The value passed should be a floating-point real number in the range between 0 and 1 (so to convert a byte variable we would have to divide by the value 255.0.)
-[[File:Scope13.jpg]] <!-- SetCustom call -->
+[[File:DataRecorderSetCustom.png|border|200px]]

@@ Line 119: / Line 119: @@
-[[File:Scope8.jpg]] <!-- AddOp call -->
+[[File:DataRecorderAddOp.png|border|200px]]
 Here is a simple program to generate a digital counter on Port B, with the signal being replicated on the Data Recorder. The [[API_System.ShowHandle|ShowHandle]] function allows the Data Recorder window to appear automatically without the user having to manually open the window.
-[[File:Scope14.jpg]] <!-- digital counter program image -->
@@ Line 136: / Line 138: @@
-[[File:Scope9.jpg]] <!-- AddAnalog function call -->
+[[File:DataRecorderAddAnalog.png|border|200px]]
@@ Line 142: / Line 144: @@
-[[File:Scope10.jpg]] <!-- potentiometer program image -->
+[[File:DataRecorderPotentiometer.png|border|600px]]

@@ Line 101: / Line 101: @@
-[[File:Scope5.jpg]] <!-- AddPort call -->
+[[File:DataRecorderAddPort.png|border|200px]]
@@ Line 107: / Line 107: @@
-[[File:Scope6.jpg]] <!-- LED program with Data Recorder -->
+[[File:DataRecorderLED.png|border|600px]]
-[[File:Scope7.jpg]] <!-- AddPort full port call -->
+To monitor a full port (e.g. Port B) with a LED Array connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.
 We then scale the stream to get the value in the range of 0-1 by calling the [[API_Scope.AddOp|AddOp]] function like this.

@@ Line 76: / Line 76: @@
-[[File:Scope3.jpg]] <!-- flow icons and created stream image -->
+[[File:DataRecorderStreamCreation.png|border|600px]]
-If you are creating your own Flowcode component, you can move these from the Main macro to the [[Event_Components.Initialise|simulation initialise event]] macro so that the group and stream are created automatically when the component is added to a program. This is the way that components such as the DSP based components add their data to the console window.
+If you are creating your own Flowcode component, you can move these from the Main macro to the [[Event_Components.Initialise|component initialise event]] macro so that the group and stream are created automatically when the component is added to a program. This is the way that components such as the DSP based components add their data to the console window.
-[[File:Scope4.jpg]] <!-- Ev_initialise image -->
+[[File:DataRecorderEvInitialise.png|border|600px]]
-Note that a group with no valid stream handles will not show up on the Data Recorder window just to try and avoid potential unnecessary clutter.
 Setting the handle variable to the value of 0 using a [[Calculation_Icon_Properties|Calculation icon]] or calling the [[API_System.DeleteHandle|System -> DeleteHandle]] API call will remove the group or stream from the Data Recorder window.

@@ Line 24: / Line 24: @@
 Streams are separated via two types: user streams and program streams.
 =====User streams=====
@@ Line 30: / Line 31: @@
 This method of adding streams is recommended if you are using [[Ghost_Technology|Ghost Technology]] to view live pin data from your Matrix hardware.
 [[File:Data_Recorder_Add_Data.png|x150px|border|Adding pins to the Data Recorder]]
 =====Program streams=====
 Program streams are added by components or by flowchart icons in your program. For some components, simply adding it to the 2d or 3d panel causes a program stream to appear in the Data Recorder. These streams are then controlled by the component itself and will be removed automatically when appropriate.
 [[File:SPI_Master_Streams.png|border|600px]]
@@ Line 42: / Line 46: @@
 Here, we will give an example of creating your own program stream using flowchart icons.
-To create a new stream group you first need to create a global “Handle” type variable to store the reference to the stream group. This is basically a unique number which used to refer to that specific group of streams in the Data Recorder. To do this, open the [[Project_Explorer|Project Explorer]] window and select the “Globals” tab. Next, right click the “Variables” portion of the tree view and select “Add New” from the menu. In the “Create a New Variable” dialogue that pops up give the variable a meaningful name such as “DRGroupHandle”, then switch the variable type to “Object handle” and click “OK”. You should then get an Object handle variable appearing in the [[Project_Explorer|Project Explorer]] window.
+======Creating a stream======
-[[File:Scope1.jpg]] <!--Created handle variable called DRGroupHandle-->
@@ Line 53: / Line 58: @@
-[[File:Scope2.jpg]] <!-- List of DataRecorder API functions -->
+[[File:DataRecorderMacros.png|border|200px]]
@@ Line 59: / Line 64: @@
-[[File:Scope3A.jpg]] <!-- Image of AddGroup with variable entered and “Test Group” -->
+[[File:DataRecorderAddGroup.png|border|200px]]
 The [[API_Scope.AddStream|AddStream]] function call adds a new named stream to the group on the Data Recorder. The return value of the function call is a handle type variable. We will have to create a new global object handle type variable to store this. This handle must be unique for each single stream so you must use a new object handle variable for every program stream that you create on the Data Recorder.
-[[File:Scope3B.jpg]] <!-- Image of AddStream with DRGroupHandle, DRStreamHandle return -->
 When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

← Older revision		Revision as of 10:28, 16 May 2019
Line 37:		Line 37:
	Program streams are added by components or by flowchart icons in your program. For some components, simply adding it to the 2d or 3d panel causes a program stream to appear in the Data Recorder. These streams are then controlled by the component itself and will be removed automatically when appropriate.		Program streams are added by components or by flowchart icons in your program. For some components, simply adding it to the 2d or 3d panel causes a program stream to appear in the Data Recorder. These streams are then controlled by the component itself and will be removed automatically when appropriate.

−	~~<!-- Image of program streams added by SPI master~~.~~-->~~	+	[[File:SPI_Master_Streams.png\|border\|600px]]