Flowcode Help - User contributions [en]

Using the Data Recorder

2019-05-17T08:02:37Z

DanielM:

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.

[[File:Data_recorder_wave_and_packets.png|border|600px]]

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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the Data Recorder itself and selecting the appropriate digital or analog pin.

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]]

Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream======

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, under the “Variables” portion of the tree view, double-click “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.

[[File:DRGroupHandle.png|border|150px]]

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the Data Recorder’s functionality.

[[File:DataRecorderMacros.png|border|200px]]

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the Data Recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “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:DataRecorderAddStream.png|border|200px]]

When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

[[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|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:DataRecorderEvInitialise.png|border|600px]]

Note that a group with no valid stream handles will not show up on the Data Recorder window, in order to 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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:DataRecorderAddPort.png|border|200px]]

Here is a simple program to toggle the LED with the signal being replicated on the Data Recorder.

[[File:DataRecorderLED.png|border|600px]]

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.

[[File:DataRecorderAddFullPort.png|border|200px]]

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.

[[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:DataRecorderLEDStrip.png|border|600px]]

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:DataRecorderAddAnalog.png|border|200px]]

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:DataRecorderPotentiometer.png|border|600px]]

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[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:DataRecorderSetCustom.png|border|200px]]

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the Data Recorder in the created stream.

[[File:DataRecorderPotAverage.png|border|600px]]

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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]]

Using the Data Recorder

2019-05-16T13:39:29Z

DanielM:

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.

[[File:Data_recorder_wave_and_packets.png|border|600px]]

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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the Data Recorder itself and selecting the appropriate digital or analog pin.

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]]

Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream======

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, under the “Variables” portion of the tree view, double-click “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.

[[File:DRGroupHandle.png|border|150px]]

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the Data Recorder’s functionality.

[[File:DataRecorderMacros.png|border|200px]]

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the Data Recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “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:DataRecorderAddStream.png|border|200px]]

When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

[[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|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:DataRecorderEvInitialise.png|border|600px]]

Note that a group with no valid stream handles will not show up on the Data Recorder window, in order to 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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:DataRecorderAddPort.png|border|200px]]

Here is a simple program to toggle the LED with the signal being replicated on the Data Recorder.

[[File:DataRecorderLED.png|border|600px]]

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.

[[File:DataRecorderAddFullPort.png|border|200px]]

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.

[[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:DataRecorderLEDStrip.png|border|600px]]

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:DataRecorderAddAnalog.png|border|200px]]

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:DataRecorderPotentiometer.png|border|600px]]

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[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:DataRecorderSetCustom.png|border|200px]]

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the Data Recorder in the created stream.

[[File:DataRecorderPotAverage.png|border|600px]]

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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]]

File:DataRecorderPotAverage.png

2019-05-16T13:38:38Z

DanielM:

Using the Data Recorder

2019-05-16T13:30:02Z

DanielM:

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.

[[File:Data_recorder_wave_and_packets.png|border|600px]]

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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the Data Recorder itself and selecting the appropriate digital or analog pin.

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]]

Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream======

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, under the “Variables” portion of the tree view, double-click “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.

[[File:DRGroupHandle.png|border|150px]]

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the Data Recorder’s functionality.

[[File:DataRecorderMacros.png|border|200px]]

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the Data Recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “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:DataRecorderAddStream.png|border|200px]]

When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

[[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|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:DataRecorderEvInitialise.png|border|600px]]

Note that a group with no valid stream handles will not show up on the Data Recorder window, in order to 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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:DataRecorderAddPort.png|border|200px]]

Here is a simple program to toggle the LED with the signal being replicated on the Data Recorder.

[[File:DataRecorderLED.png|border|600px]]

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.

[[File:DataRecorderAddFullPort.png|border|200px]]

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.

[[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:DataRecorderLEDStrip.png|border|600px]]

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:DataRecorderAddAnalog.png|border|200px]]

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:DataRecorderPotentiometer.png|border|600px]]

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[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:DataRecorderSetCustom.png|border|200px]]

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the Data Recorder in the created stream.

[[File:Scope12.jpg]] 

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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]]

File:DataRecorderSetCustom.png

2019-05-16T13:29:12Z

DanielM:

File:DataRecorderAddCustom.png

2019-05-16T13:28:56Z

DanielM:

Using the Data Recorder

2019-05-16T13:21:19Z

DanielM:

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.

[[File:Data_recorder_wave_and_packets.png|border|600px]]

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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the Data Recorder itself and selecting the appropriate digital or analog pin.

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]]

Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream======

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, under the “Variables” portion of the tree view, double-click “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.

[[File:DRGroupHandle.png|border|150px]]

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the Data Recorder’s functionality.

[[File:DataRecorderMacros.png|border|200px]]

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the Data Recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “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:DataRecorderAddStream.png|border|200px]]

When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

[[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|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:DataRecorderEvInitialise.png|border|600px]]

Note that a group with no valid stream handles will not show up on the Data Recorder window, in order to 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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:DataRecorderAddPort.png|border|200px]]

Here is a simple program to toggle the LED with the signal being replicated on the Data Recorder.

[[File:DataRecorderLED.png|border|600px]]

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.

[[File:DataRecorderAddFullPort.png|border|200px]]

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.

[[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:DataRecorderLEDStrip.png|border|600px]]

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:DataRecorderAddAnalog.png|border|200px]]

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:DataRecorderPotentiometer.png|border|600px]]

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[File:Scope11.jpg]] 

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]] 

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the Data Recorder in the created stream.

[[File:Scope12.jpg]] 

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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]]

File:DataRecorderPotentiometer.png

2019-05-16T13:20:30Z

DanielM:

File:DataRecorderAddAnalog.png

2019-05-16T13:20:06Z

DanielM:

File:DataRecorderLEDStrip.png

2019-05-16T12:58:02Z

DanielM:

File:DataRecorderAddOp.png

2019-05-16T12:57:50Z

DanielM:

Using the Data Recorder

2019-05-16T12:50:13Z

DanielM:

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.

[[File:Data_recorder_wave_and_packets.png|border|600px]]

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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the Data Recorder itself and selecting the appropriate digital or analog pin.

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]]

Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream======

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, under the “Variables” portion of the tree view, double-click “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.

[[File:DRGroupHandle.png|border|150px]]

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the Data Recorder’s functionality.

[[File:DataRecorderMacros.png|border|200px]]

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the Data Recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “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:DataRecorderAddStream.png|border|200px]]

When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

[[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|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:DataRecorderEvInitialise.png|border|600px]]

Note that a group with no valid stream handles will not show up on the Data Recorder window, in order to 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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:DataRecorderAddPort.png|border|200px]]

Here is a simple program to toggle the LED with the signal being replicated on the Data Recorder.

[[File:DataRecorderLED.png|border|600px]]

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.

[[File:DataRecorderAddFullPort.png|border|200px]]

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.

[[File:Scope8.jpg]] 

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]] 

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:Scope9.jpg]] 

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:Scope10.jpg]] 

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[File:Scope11.jpg]] 

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]] 

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the Data Recorder in the created stream.

[[File:Scope12.jpg]] 

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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]]

File:DataRecorderAddFullPort.png

2019-05-16T12:49:31Z

DanielM:

File:DataRecorderAddPort.png

2019-05-16T12:47:37Z

DanielM:

File:DataRecorderLED.png

2019-05-16T12:45:36Z

DanielM:

Using the Data Recorder

2019-05-16T12:17:26Z

DanielM:

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.

[[File:Data_recorder_wave_and_packets.png|border|600px]]

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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the Data Recorder itself and selecting the appropriate digital or analog pin.

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]]

Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream======

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, under the “Variables” portion of the tree view, double-click “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.

[[File:DRGroupHandle.png|border|150px]]

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the Data Recorder’s functionality.

[[File:DataRecorderMacros.png|border|200px]]

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the Data Recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “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:DataRecorderAddStream.png|border|200px]]

When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

[[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|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:DataRecorderEvInitialise.png|border|600px]]

Note that a group with no valid stream handles will not show up on the Data Recorder window, in order to 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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:Scope5.jpg]] 

Here is a simple program to toggle the LED with the signal being replicated on the Data Recorder.

[[File:Scope6.jpg]] 

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.

[[File:Scope7.jpg]] 

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.

[[File:Scope8.jpg]] 

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]] 

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:Scope9.jpg]] 

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:Scope10.jpg]] 

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[File:Scope11.jpg]] 

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]] 

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the Data Recorder in the created stream.

[[File:Scope12.jpg]] 

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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]]

File:DataRecorderEvInitialise.png

2019-05-16T12:16:31Z

DanielM:

File:DataRecorderStreamCreation.png

2019-05-16T12:12:19Z

DanielM:

Using the Data Recorder

2019-05-16T12:09:22Z

DanielM:

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.

[[File:Data_recorder_wave_and_packets.png|border|600px]]

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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the Data Recorder itself and selecting the appropriate digital or analog pin.

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]]

Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream======

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, under the “Variables” portion of the tree view, double-click “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.

[[File:DRGroupHandle.png|border|150px]]

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the Data Recorder’s functionality.

[[File:DataRecorderMacros.png|border|200px]]

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the Data Recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “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:DataRecorderAddStream.png|border|200px]]

When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

[[File:Scope3.jpg]] 

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.

[[File:Scope4.jpg]] 

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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:Scope5.jpg]] 

Here is a simple program to toggle the LED with the signal being replicated on the Data Recorder.

[[File:Scope6.jpg]] 

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.

[[File:Scope7.jpg]] 

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.

[[File:Scope8.jpg]] 

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]] 

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:Scope9.jpg]] 

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:Scope10.jpg]] 

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[File:Scope11.jpg]] 

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]] 

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the Data Recorder in the created stream.

[[File:Scope12.jpg]] 

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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]]

File:DataRecorderAddStream.png

2019-05-16T12:06:13Z

DanielM:

File:DataRecorderAddGroup.png

2019-05-16T12:06:03Z

DanielM:

File:DataRecorderMacros.png

2019-05-16T12:05:52Z

DanielM:

File:DRGroupHandle.png

2019-05-16T12:05:34Z

DanielM:

Using the Data Recorder

2019-05-16T10:28:55Z

DanielM:

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.

[[File:Data_recorder_wave_and_packets.png|border|600px]]

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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the Data Recorder itself and selecting the appropriate digital or analog pin.

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]]

Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream group======

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.

[[File:Scope1.jpg]] 

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the Data Recorder’s functionality.

[[File:Scope2.jpg]] 

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the Data Recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “Test Group”).

[[File:Scope3A.jpg]] 

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]] 

When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

[[File:Scope3.jpg]] 

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.

[[File:Scope4.jpg]] 

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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:Scope5.jpg]] 

Here is a simple program to toggle the LED with the signal being replicated on the Data Recorder.

[[File:Scope6.jpg]] 

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.

[[File:Scope7.jpg]] 

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.

[[File:Scope8.jpg]] 

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]] 

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:Scope9.jpg]] 

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:Scope10.jpg]] 

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[File:Scope11.jpg]] 

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]] 

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the Data Recorder in the created stream.

[[File:Scope12.jpg]] 

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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]]

File:SPI Master Streams.png

2019-05-16T10:28:29Z

DanielM:

Using the Data Recorder

2019-05-16T10:19:42Z

DanielM:

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.

[[File:Data_recorder_wave_and_packets.png|border|600px]]

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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the Data Recorder itself and selecting the appropriate digital or analog pin.

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.



Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream group======

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.

[[File:Scope1.jpg]] 

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the Data Recorder’s functionality.

[[File:Scope2.jpg]] 

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the Data Recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “Test Group”).

[[File:Scope3A.jpg]] 

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]] 

When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

[[File:Scope3.jpg]] 

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.

[[File:Scope4.jpg]] 

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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:Scope5.jpg]] 

Here is a simple program to toggle the LED with the signal being replicated on the Data Recorder.

[[File:Scope6.jpg]] 

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.

[[File:Scope7.jpg]] 

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.

[[File:Scope8.jpg]] 

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]] 

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:Scope9.jpg]] 

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:Scope10.jpg]] 

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[File:Scope11.jpg]] 

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]] 

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the Data Recorder in the created stream.

[[File:Scope12.jpg]] 

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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]]

File:Data recorder decoded packets.png

2019-05-16T10:17:09Z

DanielM:

File:Data recorder decode button.png

2019-05-16T10:16:52Z

DanielM:

Using the Data Recorder

2019-05-16T10:04:37Z

DanielM: /* User streams */

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.

[[File:Data_recorder_wave_and_packets.png|border|600px]]

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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the Data Recorder itself and selecting the appropriate digital or analog pin.

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.



Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream group======

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.

[[File:Scope1.jpg]] 

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the Data Recorder’s functionality.

[[File:Scope2.jpg]] 

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the Data Recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “Test Group”).

[[File:Scope3A.jpg]] 

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]] 

When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

[[File:Scope3.jpg]] 

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.

[[File:Scope4.jpg]] 

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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:Scope5.jpg]] 

Here is a simple program to toggle the LED with the signal being replicated on the Data Recorder.

[[File:Scope6.jpg]] 

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.

[[File:Scope7.jpg]] 

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.

[[File:Scope8.jpg]] 

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]] 

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:Scope9.jpg]] 

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:Scope10.jpg]] 

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[File:Scope11.jpg]] 

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]] 

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the Data Recorder in the created stream.

[[File:Scope12.jpg]] 

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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.



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.

Using the Data Recorder

2019-05-16T10:03:49Z

DanielM: /* How to use */

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.

[[File:Data_recorder_wave_and_packets.png|border|600px]]

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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the Data Recorder itself and selecting the appropriate digital or analog pin.

This method of adding streams is recommended if you are using Ghost technology (link) 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.



Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream group======

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.

[[File:Scope1.jpg]] 

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the Data Recorder’s functionality.

[[File:Scope2.jpg]] 

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the Data Recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “Test Group”).

[[File:Scope3A.jpg]] 

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]] 

When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

[[File:Scope3.jpg]] 

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.

[[File:Scope4.jpg]] 

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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:Scope5.jpg]] 

Here is a simple program to toggle the LED with the signal being replicated on the Data Recorder.

[[File:Scope6.jpg]] 

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.

[[File:Scope7.jpg]] 

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.

[[File:Scope8.jpg]] 

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]] 

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:Scope9.jpg]] 

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:Scope10.jpg]] 

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[File:Scope11.jpg]] 

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]] 

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the Data Recorder in the created stream.

[[File:Scope12.jpg]] 

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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.



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.

Using the Data Recorder

2019-05-16T10:01:30Z

DanielM:

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.

[[File:Data_recorder_wave_and_packets.png|border|600px]]

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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the Data Recorder itself and selecting the appropriate digital or analog pin.

This method of adding streams is recommended if you are using Ghost technology (link) to view live pin data from your Matrix hardware.



=====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.



Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream group======

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.

[[File:Scope1.jpg]] 

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the Data Recorder’s functionality.

[[File:Scope2.jpg]] 

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the Data Recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “Test Group”).

[[File:Scope3A.jpg]] 

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]] 

When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

[[File:Scope3.jpg]] 

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.

[[File:Scope4.jpg]] 

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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:Scope5.jpg]] 

Here is a simple program to toggle the LED with the signal being replicated on the Data Recorder.

[[File:Scope6.jpg]] 

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.

[[File:Scope7.jpg]] 

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.

[[File:Scope8.jpg]] 

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]] 

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:Scope9.jpg]] 

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:Scope10.jpg]] 

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[File:Scope11.jpg]] 

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]] 

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the Data Recorder in the created stream.

[[File:Scope12.jpg]] 

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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.



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 wave and packets.png

2019-05-16T09:59:56Z

DanielM:

Using the Data Recorder

2019-05-16T09:59:17Z

DanielM:

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.



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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the Data Recorder itself and selecting the appropriate digital or analog pin.

This method of adding streams is recommended if you are using Ghost technology (link) to view live pin data from your Matrix hardware.



=====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.



Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream group======

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.

[[File:Scope1.jpg]] 

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the Data Recorder’s functionality.

[[File:Scope2.jpg]] 

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the Data Recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “Test Group”).

[[File:Scope3A.jpg]] 

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]] 

When we run the simulation the new group will be created on the Data Recorder ready for data to be streamed in.

[[File:Scope3.jpg]] 

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.

[[File:Scope4.jpg]] 

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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:Scope5.jpg]] 

Here is a simple program to toggle the LED with the signal being replicated on the Data Recorder.

[[File:Scope6.jpg]] 

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.

[[File:Scope7.jpg]] 

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.

[[File:Scope8.jpg]] 

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]] 

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:Scope9.jpg]] 

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:Scope10.jpg]] 

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[File:Scope11.jpg]] 

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]] 

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the Data Recorder in the created stream.

[[File:Scope12.jpg]] 

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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.



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.

Using the Data Recorder

2019-05-16T09:55:22Z

DanielM: DanielM moved page Using the Data Scope to Using the Data Recorder

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.



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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the data recorder itself and selecting the appropriate digital or analog pin.

This method of adding streams is recommended if you are using Ghost technology (link) to view live pin data from your Matrix hardware.



=====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.



Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream group======

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.

[[File:Scope1.jpg]] 

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the data recorder’s functionality.

[[File:Scope2.jpg]] 

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the data recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “Test Group”).

[[File:Scope3A.jpg]] 

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]] 

When we run the simulation the new group will be created on the data recorder ready for data to be streamed in.

[[File:Scope3.jpg]] 

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.

[[File:Scope4.jpg]] 

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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires:
*the stream object handle,
*the port index where PORTA is 0, PORTB is 1 etc.
*the BitMask parameter. This is a binary AND mask which selects which bits of the port will be available on the stream.
*The PackMask parameter. Setting this to 1 will move all the active bits together if necessary.
*The merge parameter. This allows you to add multiple ports or pins to a single stream. Set this to 1 if you are adding a digital pin or port to an existing stream that already contains data, and you wish to combine the data.

To monitor a single pin (e.g. Port A, Pin 0) with an LED connected, we can call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:Scope5.jpg]] 

Here is a simple program to toggle the LED with the signal being replicated on the data recorder.

[[File:Scope6.jpg]] 

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.

[[File:Scope7.jpg]] 

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.

[[File:Scope8.jpg]] 

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]] 

======Adding an analogue pin to a program stream======

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires:
*the stream object handle,
*the analogue channel index where An0 is 0, An1 is 1 etc.
*the Subtract parameter. This allows you to add or subtract multiple analogue signals on a single stream. Set this to 1 if you are adding an analog pin to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To monitor a single analogue pin (e.g. pin An0), with a potentiometer connected, we can call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:Scope9.jpg]] 

Here is a simple program to track the value of pin An0, based on the position of the potentiometer.

[[File:Scope10.jpg]] 

======Adding a custom value to a program stream======

Custom values are those that do not correspond directly to pins or ports. A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires:
*the stream object handle,
*the custom channel index 0-31. These act as “slots” in which to store your data. Select a value that is not used by any other custom streams.
*the Subtract parameter. This allows you to add or subtract multiple custom channels on a single stream. Set this to 1 if you are adding a custom channel to an existing stream that already contains data, and you wish to subtract the data. Alternatively set it to 0 if you wish to add/combine the data.

To create a single custom stream, we can call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[File:Scope11.jpg]] 

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]] 

Here is a simple program which creates a custom stream, adds custom channel 0 to it, and then continually:
# tracks the values of two analogue input signals
# calculates the average between the two readings.
# sends the data to custom channel 0, which appears on the data recorder in the created stream.

[[File:Scope12.jpg]] 

===Interacting with streams===

You can change the time span that is being examined by using the drop down on the top-right of the window. Alternatively, you can use your mouse’s scroll wheel. Using the scroll wheel is even more powerful as it allows you to zoom directly over a particular point of interest.
Stream heights can be modified by dragging the bottom border of the left hand pane for the relevant stream. Colours used for rendering can be modified on the fly directly, by clicking the top square next to the stream name (for the stream background colour), and the bottom square next to the stream name (for the stream waveform/foreground colour)

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===

Communications buses can be decoded to work out what values a bus is sending out and receiving.

Supported Busses:
*UART (RS232, GSM, GPS, Modbus, Bluetooth, ...)
*SPI (SPI Master, FAT, EEPROM, RTC, ...)
*I2C (I2C Master, Accelerometer, EEPROM, RTC, ...)

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.



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.

Using the Data Scope

2019-05-16T09:55:22Z

DanielM: DanielM moved page Using the Data Scope to Using the Data Recorder

#REDIRECT [[Using the Data Recorder]]

Using the Data Recorder

2019-05-16T09:49:26Z

DanielM:

Using the Data Recorder

2019-05-16T09:40:41Z

DanielM:

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

===Introduction===

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.



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===

====Adding streams====

Streams are separated via two types: user streams and program streams.

=====User streams=====

User streams are simple streams that allow you to easily monitor the value of a digital or analog pin. They can be added by simply clicking the “Add pin trace” button on the data recorder itself and selecting the appropriate digital or analog pin.

This method of adding streams is recommended if you are using Ghost technology (link) to view live pin data from your Matrix hardware.



=====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.



Here, we will give an example of creating your own program stream using flowchart icons.

======Creating a stream group======

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.

[[File:Scope1.jpg]] 

Next, we need to assign the handle variable with a value by calling the Flowcode API. To do this we add a Simulation Macro (link) icon to the “Main” flowchart. Then we double-click the icon on the flowchart to edit the icon's properties. Inside the icon property window we first need to ensure that the “Functions” tab is selected and then scroll down to the “DataRecorder” section before clicking the + icon to see all the API calls related to the data recorder’s functionality.

[[File:Scope2.jpg]] 

The [[API_Scope.AddGroup|AddGroup]] function call creates a new named group of streams on the data recorder. The return value of the function call requires a handle type variable. You should set this to the name of the variable we have created previously (“DRGroupHandle” in this example). Type a name that you want into the parameter field, (such as “Test Group”).

[[File:Scope3A.jpg]] 

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]] 

When we run the simulation the new group will be created on the data recorder ready for data to be streamed in.

[[File:Scope3.jpg]] 

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.

[[File:Scope4.jpg]] 

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.

======Adding a digital pin or port to a program stream======

A digital pin or port can be assigned to a stream object handle by using the [[API_Scope.AddPort|AddPort]] function call. The function requires the stream object handle, the port index where PORTA is 0, PORTB is 1 etc. The BitMask parameter is a binary AND mask which selects which bits of the port will be available on the scope stream. The PackMask parameter will move all the active bits together if necessary. The merge parameter allows you to add multiple ports or pins to a single stream.

To monitor a single pin with a LED connected to port pin A0 we can simply call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:Scope5.jpg]]

Here is a simple program to toggle the LED with the signal being replicated on the scope trace.

[[File:Scope6.jpg]]

To monitor a full port with a LED Array connected to PortB we can simply call the [[API_Scope.AddPort|AddPort]] function like this.

[[File:Scope7.jpg]]

We then need to scale the scope channel to get the value in the range of 0-1 by calling the [[API_Scope.AddOp|AddOp]] function like this.

[[File:Scope8.jpg]]

Here is a simple program to generate a digital counter on the port with the signal being replicated on the scope trace. The [[API_System.ShowHandle|ShowHandle]] function allows the Scope window to appear automatically without the user having to manually open the Scope window.

[[File:Scope14.jpg]]

===Adding an analogue pin to a stream===

An analogue pin can be assigned to a stream object handle by using the [[API_Scope.AddAnalog|AddAnalog]] function call. The function requires the stream object handle, the analogue channel index where AN0 is 0, AN1 is 1 etc. The subtract parameter allows you to add or subtract multiple analogue signals on a single stream.

To monitor a single analogue pin with a potentiometer connected to pin AN0 we can simply call the [[API_Scope.AddAnalog|AddAnalog]] function like this.

[[File:Scope9.jpg]]

Here is a simple program to track the value of an analogue input signal based on the position of the potentiometer.

[[File:Scope10.jpg]]

===Adding an custom value to a stream===

A custom value can be assigned to a stream object handle by using the [[API_Scope.AddCustom|AddCustom]] function call. The function requires the stream object handle, the custom channel index 0-31 for each stream handle. The subtract parameter allows you to add or subtract multiple signals on a single stream.

To create a single custom stream we can simply call the [[API_Scope.AddCustom|AddCustom]] function like this.

[[File:Scope11.jpg]]

The data for a custom channel cannot come from a digital or analogue channel automatically so 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 have to divide by the value 255.0.

[[File:Scope13.jpg]]

Here is a simple program to track the values of two analogue input signals and then calculate and plot the average between the two readings.

[[File:Scope12.jpg]]

Ghost Technology

2019-05-14T13:56:22Z

DanielM:

==What is Ghost Technology?==

[[File:Ghost_Overview.png|border|800px]]

Ghost is a technology which, when combined with Flowcode, provides a revolutionary way of debugging electronic systems.
Ghost technology provides a real time log of the status of all the pins on the microcontroller while a program is running on the device. The data is viewed on the Flowcode Oscillscope or Data Recorder. We call this ‘In-Circuit-Test’.

It also provides the ability to control the program that is running on the microcontroller from Flowcode itself. You can run, pause, and step through your program and view Ghost data at the same time. View variables, registers and other memory locations. We call this “In-Circuit-Debug”.

When Ghost is combined with the PC-side processing capabilities of Flowcode it provides a very powerful debugging and learning tool. This saves huge amounts of development time - whether you are working at a pin level and getting your first program to work, or whether you are an advanced user wanting to perform a sanity check to make sure communications baud rates are set at the correct speed.

Both analogue and digital data is gathered through Ghost and displayed on the Flowcode Oscilloscope and Data Recorder. For communications busses, decoding overlays for SPI, I2C, and other comms standards are available. Ghost data can also be passed to simulation/SCADA components in Flowcode to provide Human Machine Interface style debug features.
You can find an example [http://www.matrixtsl.com/ghost here].

Ghost is watching over your hardware!

==In-Circuit-Test (Pin monitoring)==

In-Circuit-Test (ICT) functionality is a key feature provided by Ghost. It allows monitoring of all the external signals of your target microcontroller by displaying real time signal data on the Oscilloscope or Data Recorder. Signal data corresponding with communication busses can be decoded with the data appearing in a nice formatted way on either the Data Recorder or the Console Window.
When ICT is enabled or disabled there is no need to re-program the target device. It is not possible to use ICT when Flowcode simulation is running, unless you are running ICD mode (see the section on ICD below).

===Supported hardware===

* Matrix EB006 PIC Multiprogrammer Version 9
* Matrix EB091 dsPIC Programmer
* Matrix Flowkit II ICD tool - Compatible with Arduino and 3rd party hardware.
* Matrix BL0011 PIC Programmer
* Matrix BL0032 dsPIC Programmer
* Matrix BL0036 Raspberry Pi shield
* Matrix BL0061 ARM Programmer
* Matrix BL0080 PIC Multiprogrammer
* Matrix BL0055 Arduino Shield
* Matrix BL0086 AVR Programmer

===How to use===

# Plug your board into your PC and ensure that the correct drivers are installed (found in the Flowcode install directory)
# Add your chosen pins to the [[Data_Scope | Data Recorder]] or [[Oscilloscope | Oscilloscope]]
#:[[File:Data_Recorder_Add_Data.png|x150px|border|Adding pins to the Data Recorder]]           [[File:Oscilloscope_Add_Data.png|x150px|border|Adding pins to the Oscilloscope]]
# Click the Ghost button on the [[Data_Scope | Data Recorder]] or [[Oscilloscope | Oscilloscope]]
#:[[File:Data_Recorder_Ghost_Button.png|x50px|border|Activate Ghost from the Data Recorder]]             [[File:Oscilloscope_Ghost_Button.png|x50px|border|Activate Ghost from the Oscilloscope]]

Please click [[Data_Scope | here]] to learn more about the Data Recorder

Please click [[Oscilloscope | here]] to learn more about the Oscilloscope

==In-Circuit-Debug (Remote control of execution)==

In-Circuit-Debug (ICD) allows breakpoints, single stepping, and other simulation features such as the Simulation Debugger to work seamlessly with your program running directly on the target Microcontroller.

When ICD is enabled you must re-program the target device to allow the ghost specific code to be loaded onto the target device. Once the device has been programmed, it will stay in a waiting state until Flowcode signals it to start running. Clicking the simulation run or step buttons in Flowcode will trigger the target device to react accordingly. Clicking the simulation stop button will reset the target device so that it restarts from the very start of the program. When disabling ICD you again need to re-compile and program the device to allow the ghost specific code to be removed from the program.

===Supported hardware===

* Matrix EB006 PIC Multiprogrammer Version 9
* Matrix EB064 dsPIC Multiprogrammer Version 2
* Matrix EB091 dsPIC Programmer
* Matrix Flowkit ICD tool - Compatible with MIAC, ECIO, FormulaFlowcode and 3rd party hardware.
* Matrix Flowkit II ICD tool - Compatible with Arduino and 3rd party hardware.
* Matrix BL0011 PIC Programmer
* Matrix BL0032 dsPIC Programmer
* Matrix BL0036 Raspberry Pi shield
* Matrix BL0061 ARM Programmer
* Matrix BL0080 PIC Multiprogrammer
* Matrix BL0055 Arduino Shield
* Matrix BL0086 AVR Programmer

===How to use===

# Develop your program using Flowcode as normal until you are ready to test the results.
# With a Ghost-compatible board connected, click on the ICD button on the main toolbar so that the toolbar changes to green
#:[[File:ICD_green_toolbar.png|border|x70px| Enabling ICD mode]]
# Click Compile-To-Chip, to send the Ghost code to your device.
#:[[File:ICD_Compile_To_Chip.png|border|x70px|Sending ICD code to the microcontroller]]
# Click Play button or Step Into / Step Over to begin execution.
#:[[File:ICD_Play.png|border|x70px|Starting ICD execution at full speed]]           [[File:ICD_Step_Into.png|border|x70px|Starting ICD execution in step mode]]
# When you are finished. Click Stop and then the ICD button again, so that the toolbar returns to its original colour. Click Compile-To-Chip again so that the Ghost code is removed from the program.

Note that you can slow down execution speed using the Simulation Debugger window and monitor the values of variables in the same way as when you are using simulation. ICT is also available when running your program via ICD.

==Advanced Ghost Settings==

For advanced users, you can modify certain operating parameters for Ghost in its settings window. If you have a Ghost device plugged into your PC, you can click the double cog icon on the Oscilloscope or Data Recorder, or the Ghost settings icon on the main toolbar to open the Ghost settings.

[[File:Oscilloscope_Ghost_Settings.png|x50px|border|Ghost settings button on Oscilloscope]]           [[File:Data_Recorder_Ghost_Settings.png|x50px|border|Ghost settings button on Data Recorder]]           [[File:Ghost_Options_Main.png|x50px|border|Ghost settings button on main toolbar]]

===Sample masks===

You can set the sample mask that Ghost uses to decide which pins should be recorded. It is recommended for most cases that you leave this set to automatic mode.

[[File:Ghost_Auto_Sample.png|border|400px|Automatic sampling mode (recommended)]]

However, if you wish to set the sample mask manually, you can uncheck the box and choose which pins should be sampled.

[[File:Ghost_Manual_Sample.png|border|400px|Manually selecting which pins should be sampled]]

===General settings===
The settings tab controls various aspects of the ICD and ICT functionality.

[[File:Ghost_Settings_Tab.png|400px|border|General Ghost settings]]

'''ICT Settings''': Controls the digital and analog sample rates, note that the analogue sample rate is scaled based on the digital sample rate.

'''ICD Settings''': Controls the number of breakpoints, the maximum size of the stack and the communications time-out delay.

'''Flowkit 2 Settings''': Only configurable when you have a FlowKit 2 board connected, these control the two target pins used for ICD communications. These pins cannot be used in your program or you risk ICD communications being unreliable or unavailable.

'''Enable Overflow and Wrap''': This controls what happens if the ICT buffer runs out of memory.
* Checked: If the ICT buffer runs out of memory then the contents of memory are wiped allowing ICT to continue, you may notice a glitch on your scope traces.
* Unchecked: If the ICT buffer runs out of memory then ICT mode is automatically switched off, this guarantees that there are no glitches in the data.

'''Auto-activate ICT when running ICD''': This automatically toggles ICT (pin sampling) when ICD is running. Note that there is no other way to make use of the data recorder otherwise, as simulation data is not available in ICD mode.

File:Ghost Overview.png

2019-05-14T13:54:01Z

DanielM:

Oscilloscope

2019-05-14T13:24:23Z

DanielM:

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

==Introduction==

Flowcode includes a 4 channel, fully triggering oscilloscope, 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 [[Ghost_Technology#In-Circuit-Test_.28Pin_monitoring.29 | In-Circuit-Test]]. It can also be used in simulation mode, though timing of signals is not accurate when using simulation.

[[File:Oscilloscope.jpg|border|800px|Oscilloscope window showing a sine wave]]

Please note that the oscilloscope is not designed for viewing extremely high-speed signals (in the microsecond range) over long time periods. For this type of analysis, we recommend the [[Using_the_Data_Scope|Data Recorder]].

==How to use==

To setup a channel, simply click the Add data button for a channel, and select the relevant analog or digital, then click ok. When simulation starts, you’ll begin to see data appear on the screen. If you are using Matrix hardware, you can click the Ghost button when simulation is not running in order to view live data from the microcontroller. You can add up to 4 channels simultaneously, and hide existing channels by unchecking the check boxes.

You can drag the arrow that represents the 0V base line for a channel, in order to modify the waveform’s vertical offset. You can also click use the combo-boxes underneath the grid in order to modify the height of channels.

In order to modify the time, use the drop-down combo box on the bottom-left, labelled “Scale”. To tell Flowcode that your board is operating in 3V3 voltage mode, use the checkbox at the top of the window.

==Triggering==

Triggering allows the view of the data to remain fixed until an event happens. Click “Use Trigger” to activate trigger mode. You will see the data disappear until the trigger is armed. The settings for modifying the trigger behaviour are as follows:

[[File:Oscilloscope_Trigger.png|border|x200px|Trigger settings on Oscilloscope]]

'''Sweep type''': If set to “Single”, then after firing, the oscilloscope will draw to the right end of the screen and then maintain the image until the trigger is re-armed. If set to “Repeat”, the trigger will remain armed after firing, and after the oscilloscope has drawn to the right end of the screen, re-fire when the event next occurs.

'''Edge event''': When set to “Rising”, the trigger fires when the selected channel’s waveform passes above the horizontal trigger line (set using the arrow on the right side of the oscilloscope). When set to “Falling”, the trigger fires when the selected channel’s waveform passes below the horizontal trigger line.

'''Source channel''': This sets the channel that will be used to detect an edge event, and then fire the trigger.

'''Arm''': If this is toggled active, the trigger is armed and will next fire when the edge event next occurs (in “Single” sweep type), or when the edge event next occurs and the oscilloscope has already drawn to the edge of the screen (in “Repeat” sweep type).

You can drag the arrow at the bottom of the oscilloscope to the left or right, in order to set where you want the edge event to be displayed once the trigger fires. This allows you to change how much data before or after the edge event you would like to view.

Ghost Technology

2019-05-14T13:23:57Z

DanielM:

==What is Ghost Technology?==

Ghost is a technology which, when combined with Flowcode, provides a revolutionary way of debugging electronic systems.
Ghost technology provides a real time log of the status of all the pins on the microcontroller while a program is running on the device. The data is viewed on the Flowcode Oscillscope or Data Recorder. We call this ‘In-Circuit-Test’.

It also provides the ability to control the program that is running on the microcontroller from Flowcode itself. You can run, pause, and step through your program and view Ghost data at the same time. View variables, registers and other memory locations. We call this “In-Circuit-Debug”.

When Ghost is combined with the PC-side processing capabilities of Flowcode it provides a very powerful debugging and learning tool. This saves huge amounts of development time - whether you are working at a pin level and getting your first program to work, or whether you are an advanced user wanting to perform a sanity check to make sure communications baud rates are set at the correct speed.

Both analogue and digital data is gathered through Ghost and displayed on the Flowcode Oscilloscope and Data Recorder. For communications busses, decoding overlays for SPI, I2C, and other comms standards are available. Ghost data can also be passed to simulation/SCADA components in Flowcode to provide Human Machine Interface style debug features.
You can find an example [http://www.matrixtsl.com/ghost here].

Ghost is watching over your hardware!

==In-Circuit-Test (Pin monitoring)==

In-Circuit-Test (ICT) functionality is a key feature provided by Ghost. It allows monitoring of all the external signals of your target microcontroller by displaying real time signal data on the Oscilloscope or Data Recorder. Signal data corresponding with communication busses can be decoded with the data appearing in a nice formatted way on either the Data Recorder or the Console Window.
When ICT is enabled or disabled there is no need to re-program the target device. It is not possible to use ICT when Flowcode simulation is running, unless you are running ICD mode (see the section on ICD below).

===Supported hardware===

* Matrix EB006 PIC Multiprogrammer Version 9
* Matrix EB091 dsPIC Programmer
* Matrix Flowkit II ICD tool - Compatible with Arduino and 3rd party hardware.
* Matrix BL0011 PIC Programmer
* Matrix BL0032 dsPIC Programmer
* Matrix BL0036 Raspberry Pi shield
* Matrix BL0061 ARM Programmer
* Matrix BL0080 PIC Multiprogrammer
* Matrix BL0055 Arduino Shield
* Matrix BL0086 AVR Programmer

===How to use===

# Plug your board into your PC and ensure that the correct drivers are installed (found in the Flowcode install directory)
# Add your chosen pins to the [[Data_Scope | Data Recorder]] or [[Oscilloscope | Oscilloscope]]
#:[[File:Data_Recorder_Add_Data.png|x150px|border|Adding pins to the Data Recorder]]           [[File:Oscilloscope_Add_Data.png|x150px|border|Adding pins to the Oscilloscope]]
# Click the Ghost button on the [[Data_Scope | Data Recorder]] or [[Oscilloscope | Oscilloscope]]
#:[[File:Data_Recorder_Ghost_Button.png|x50px|border|Activate Ghost from the Data Recorder]]             [[File:Oscilloscope_Ghost_Button.png|x50px|border|Activate Ghost from the Oscilloscope]]

Please click [[Data_Scope | here]] to learn more about the Data Recorder

Please click [[Oscilloscope | here]] to learn more about the Oscilloscope

==In-Circuit-Debug (Remote control of execution)==

In-Circuit-Debug (ICD) allows breakpoints, single stepping, and other simulation features such as the Simulation Debugger to work seamlessly with your program running directly on the target Microcontroller.

When ICD is enabled you must re-program the target device to allow the ghost specific code to be loaded onto the target device. Once the device has been programmed, it will stay in a waiting state until Flowcode signals it to start running. Clicking the simulation run or step buttons in Flowcode will trigger the target device to react accordingly. Clicking the simulation stop button will reset the target device so that it restarts from the very start of the program. When disabling ICD you again need to re-compile and program the device to allow the ghost specific code to be removed from the program.

===Supported hardware===

* Matrix EB006 PIC Multiprogrammer Version 9
* Matrix EB064 dsPIC Multiprogrammer Version 2
* Matrix EB091 dsPIC Programmer
* Matrix Flowkit ICD tool - Compatible with MIAC, ECIO, FormulaFlowcode and 3rd party hardware.
* Matrix Flowkit II ICD tool - Compatible with Arduino and 3rd party hardware.
* Matrix BL0011 PIC Programmer
* Matrix BL0032 dsPIC Programmer
* Matrix BL0036 Raspberry Pi shield
* Matrix BL0061 ARM Programmer
* Matrix BL0080 PIC Multiprogrammer
* Matrix BL0055 Arduino Shield
* Matrix BL0086 AVR Programmer

===How to use===

# Develop your program using Flowcode as normal until you are ready to test the results.
# With a Ghost-compatible board connected, click on the ICD button on the main toolbar so that the toolbar changes to green
#:[[File:ICD_green_toolbar.png|border|x70px| Enabling ICD mode]]
# Click Compile-To-Chip, to send the Ghost code to your device.
#:[[File:ICD_Compile_To_Chip.png|border|x70px|Sending ICD code to the microcontroller]]
# Click Play button or Step Into / Step Over to begin execution.
#:[[File:ICD_Play.png|border|x70px|Starting ICD execution at full speed]]           [[File:ICD_Step_Into.png|border|x70px|Starting ICD execution in step mode]]
# When you are finished. Click Stop and then the ICD button again, so that the toolbar returns to its original colour. Click Compile-To-Chip again so that the Ghost code is removed from the program.

Note that you can slow down execution speed using the Simulation Debugger window and monitor the values of variables in the same way as when you are using simulation. ICT is also available when running your program via ICD.

==Advanced Ghost Settings==

For advanced users, you can modify certain operating parameters for Ghost in its settings window. If you have a Ghost device plugged into your PC, you can click the double cog icon on the Oscilloscope or Data Recorder, or the Ghost settings icon on the main toolbar to open the Ghost settings.

[[File:Oscilloscope_Ghost_Settings.png|x50px|border|Ghost settings button on Oscilloscope]]           [[File:Data_Recorder_Ghost_Settings.png|x50px|border|Ghost settings button on Data Recorder]]           [[File:Ghost_Options_Main.png|x50px|border|Ghost settings button on main toolbar]]

===Sample masks===

You can set the sample mask that Ghost uses to decide which pins should be recorded. It is recommended for most cases that you leave this set to automatic mode.

[[File:Ghost_Auto_Sample.png|border|400px|Automatic sampling mode (recommended)]]

However, if you wish to set the sample mask manually, you can uncheck the box and choose which pins should be sampled.

[[File:Ghost_Manual_Sample.png|border|400px|Manually selecting which pins should be sampled]]

===General settings===
The settings tab controls various aspects of the ICD and ICT functionality.

[[File:Ghost_Settings_Tab.png|400px|border|General Ghost settings]]

'''ICT Settings''': Controls the digital and analog sample rates, note that the analogue sample rate is scaled based on the digital sample rate.

'''ICD Settings''': Controls the number of breakpoints, the maximum size of the stack and the communications time-out delay.

'''Flowkit 2 Settings''': Only configurable when you have a FlowKit 2 board connected, these control the two target pins used for ICD communications. These pins cannot be used in your program or you risk ICD communications being unreliable or unavailable.

'''Enable Overflow and Wrap''': This controls what happens if the ICT buffer runs out of memory.
* Checked: If the ICT buffer runs out of memory then the contents of memory are wiped allowing ICT to continue, you may notice a glitch on your scope traces.
* Unchecked: If the ICT buffer runs out of memory then ICT mode is automatically switched off, this guarantees that there are no glitches in the data.

'''Auto-activate ICT when running ICD''': This automatically toggles ICT (pin sampling) when ICD is running. Note that there is no other way to make use of the data recorder otherwise, as simulation data is not available in ICD mode.

Ghost Technology

2019-05-14T13:22:29Z

DanielM: /* How to use */

Oscilloscope

2019-05-14T13:08:46Z

DanielM: /* Triggering */

Oscilloscope

2019-05-14T13:08:36Z

DanielM: /* Triggering */

File:Oscilloscope Trigger.png

2019-05-14T13:06:38Z

DanielM:

Oscilloscope

2019-05-14T13:02:51Z

DanielM: /* Introduction */

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

==Introduction==

Flowcode includes a 4 channel, fully triggering oscilloscope, 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 [[Ghost_Technology#In-Circuit-Test_.28Pin_monitoring.29 | In-Circuit-Test]]. It can also be used in simulation mode, though timing of signals is not accurate when using simulation.

[[File:Oscilloscope.jpg|border|800px|Oscilloscope window showing a sine wave]]

Please note that the oscilloscope is not designed for viewing extremely high-speed signals (in the microsecond range) over long time periods. For this type of analysis, we recommend the [[Using_the_Data_Scope|Data Recorder]].

==How to use==

To setup a channel, simply click the Add data button for a channel, and select the relevant analog or digital, then click ok. When simulation starts, you’ll begin to see data appear on the screen. If you are using Matrix hardware, you can click the Ghost button when simulation is not running in order to view live data from the microcontroller. You can add up to 4 channels simultaneously, and hide existing channels by unchecking the check boxes.

You can drag the arrow that represents the 0V base line for a channel, in order to modify the waveform’s vertical offset. You can also click use the combo-boxes underneath the grid in order to modify the height of channels.

In order to modify the time, use the drop-down combo box on the bottom-left, labelled “Scale”. To tell Flowcode that your board is operating in 3V3 voltage mode, use the checkbox at the top of the window.

==Triggering==

Triggering allows the view of the data to remain fixed until an event happens. Click “Use Trigger” to activate trigger mode. You will see the data disappear until the trigger is armed. The settings for modifying the trigger behaviour are as follows:

'''Sweep type''': If set to “Single”, then after firing, the oscilloscope will draw to the right end of the screen and then maintain the image until the trigger is re-armed. If set to “Repeat”, the trigger will remain armed after firing, and after the oscilloscope has drawn to the right end of the screen, re-fire when the event next occurs.

'''Edge event''': When set to “Rising”, the trigger fires when the selected channel’s waveform passes above the horizontal trigger line (set using the arrow on the right side of the oscilloscope). When set to “Falling”, the trigger fires when the selected channel’s waveform passes below the horizontal trigger line.

'''Source channel''': This sets the channel that will be used to detect an edge event, and then fire the trigger.

'''Arm''': If this is toggled active, the trigger is armed and will next fire when the edge event next occurs (in “Single” sweep type), or when the edge event next occurs and the oscilloscope has already drawn to the edge of the screen (in “Repeat” sweep type).

You can drag the arrow at the bottom of the oscilloscope to the left or right, in order to set where you want the edge event to be displayed once the trigger fires. This allows you to change how much data before or after the edge event you would like to view.

Oscilloscope

2019-05-14T13:02:42Z

DanielM: /* Introduction */

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

==Introduction==

Flowcode includes a 4 channel, fully triggering oscilloscope, 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 [[Ghost_Technology#In-Circuit-Test_.28Pin_monitoring.29 | In-Circuit-Test]]. It can also be used in simulation mode, though timing of signals is not accurate when using simulation.

[[File:Oscilloscope.jpg|border|300px|Oscilloscope window showing a sine wave]]

Please note that the oscilloscope is not designed for viewing extremely high-speed signals (in the microsecond range) over long time periods. For this type of analysis, we recommend the [[Using_the_Data_Scope|Data Recorder]].

==How to use==

To setup a channel, simply click the Add data button for a channel, and select the relevant analog or digital, then click ok. When simulation starts, you’ll begin to see data appear on the screen. If you are using Matrix hardware, you can click the Ghost button when simulation is not running in order to view live data from the microcontroller. You can add up to 4 channels simultaneously, and hide existing channels by unchecking the check boxes.

You can drag the arrow that represents the 0V base line for a channel, in order to modify the waveform’s vertical offset. You can also click use the combo-boxes underneath the grid in order to modify the height of channels.

In order to modify the time, use the drop-down combo box on the bottom-left, labelled “Scale”. To tell Flowcode that your board is operating in 3V3 voltage mode, use the checkbox at the top of the window.

==Triggering==

Triggering allows the view of the data to remain fixed until an event happens. Click “Use Trigger” to activate trigger mode. You will see the data disappear until the trigger is armed. The settings for modifying the trigger behaviour are as follows:

'''Sweep type''': If set to “Single”, then after firing, the oscilloscope will draw to the right end of the screen and then maintain the image until the trigger is re-armed. If set to “Repeat”, the trigger will remain armed after firing, and after the oscilloscope has drawn to the right end of the screen, re-fire when the event next occurs.

'''Edge event''': When set to “Rising”, the trigger fires when the selected channel’s waveform passes above the horizontal trigger line (set using the arrow on the right side of the oscilloscope). When set to “Falling”, the trigger fires when the selected channel’s waveform passes below the horizontal trigger line.

'''Source channel''': This sets the channel that will be used to detect an edge event, and then fire the trigger.

'''Arm''': If this is toggled active, the trigger is armed and will next fire when the edge event next occurs (in “Single” sweep type), or when the edge event next occurs and the oscilloscope has already drawn to the edge of the screen (in “Repeat” sweep type).

You can drag the arrow at the bottom of the oscilloscope to the left or right, in order to set where you want the edge event to be displayed once the trigger fires. This allows you to change how much data before or after the edge event you would like to view.

Oscilloscope

2019-05-14T13:02:27Z

DanielM: /* Introduction */

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

==Introduction==

Flowcode includes a 4 channel, fully triggering oscilloscope, 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 [[Ghost_Technology#In-Circuit-Test_.28Pin_monitoring.29 | In-Circuit-Test]]. It can also be used in simulation mode, though timing of signals is not accurate when using simulation.

[[File:Oscilloscope.jpg|border|x300px|Oscilloscope window showing a sine wave]]

Please note that the oscilloscope is not designed for viewing extremely high-speed signals (in the microsecond range) over long time periods. For this type of analysis, we recommend the [[Using_the_Data_Scope|Data Recorder]].

==How to use==

To setup a channel, simply click the Add data button for a channel, and select the relevant analog or digital, then click ok. When simulation starts, you’ll begin to see data appear on the screen. If you are using Matrix hardware, you can click the Ghost button when simulation is not running in order to view live data from the microcontroller. You can add up to 4 channels simultaneously, and hide existing channels by unchecking the check boxes.

You can drag the arrow that represents the 0V base line for a channel, in order to modify the waveform’s vertical offset. You can also click use the combo-boxes underneath the grid in order to modify the height of channels.

In order to modify the time, use the drop-down combo box on the bottom-left, labelled “Scale”. To tell Flowcode that your board is operating in 3V3 voltage mode, use the checkbox at the top of the window.

==Triggering==

Triggering allows the view of the data to remain fixed until an event happens. Click “Use Trigger” to activate trigger mode. You will see the data disappear until the trigger is armed. The settings for modifying the trigger behaviour are as follows:

'''Sweep type''': If set to “Single”, then after firing, the oscilloscope will draw to the right end of the screen and then maintain the image until the trigger is re-armed. If set to “Repeat”, the trigger will remain armed after firing, and after the oscilloscope has drawn to the right end of the screen, re-fire when the event next occurs.

'''Edge event''': When set to “Rising”, the trigger fires when the selected channel’s waveform passes above the horizontal trigger line (set using the arrow on the right side of the oscilloscope). When set to “Falling”, the trigger fires when the selected channel’s waveform passes below the horizontal trigger line.

'''Source channel''': This sets the channel that will be used to detect an edge event, and then fire the trigger.

'''Arm''': If this is toggled active, the trigger is armed and will next fire when the edge event next occurs (in “Single” sweep type), or when the edge event next occurs and the oscilloscope has already drawn to the edge of the screen (in “Repeat” sweep type).

You can drag the arrow at the bottom of the oscilloscope to the left or right, in order to set where you want the edge event to be displayed once the trigger fires. This allows you to change how much data before or after the edge event you would like to view.

Oscilloscope

2019-05-14T13:02:09Z

DanielM: /* Introduction */

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

==Introduction==

Flowcode includes a 4 channel, fully triggering oscilloscope, 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 [[Ghost_Technology#In-Circuit-Test_.28Pin_monitoring.29 | In-Circuit-Test]]. It can also be used in simulation mode, though timing of signals is not accurate when using simulation.

[[File:Oscilloscope.jpg|border|x600px|Oscilloscope window showing a sine wave]]

Please note that the oscilloscope is not designed for viewing extremely high-speed signals (in the microsecond range) over long time periods. For this type of analysis, we recommend the [[Using_the_Data_Scope|Data Recorder]].

==How to use==

To setup a channel, simply click the Add data button for a channel, and select the relevant analog or digital, then click ok. When simulation starts, you’ll begin to see data appear on the screen. If you are using Matrix hardware, you can click the Ghost button when simulation is not running in order to view live data from the microcontroller. You can add up to 4 channels simultaneously, and hide existing channels by unchecking the check boxes.

You can drag the arrow that represents the 0V base line for a channel, in order to modify the waveform’s vertical offset. You can also click use the combo-boxes underneath the grid in order to modify the height of channels.

In order to modify the time, use the drop-down combo box on the bottom-left, labelled “Scale”. To tell Flowcode that your board is operating in 3V3 voltage mode, use the checkbox at the top of the window.

==Triggering==

Triggering allows the view of the data to remain fixed until an event happens. Click “Use Trigger” to activate trigger mode. You will see the data disappear until the trigger is armed. The settings for modifying the trigger behaviour are as follows:

'''Sweep type''': If set to “Single”, then after firing, the oscilloscope will draw to the right end of the screen and then maintain the image until the trigger is re-armed. If set to “Repeat”, the trigger will remain armed after firing, and after the oscilloscope has drawn to the right end of the screen, re-fire when the event next occurs.

'''Edge event''': When set to “Rising”, the trigger fires when the selected channel’s waveform passes above the horizontal trigger line (set using the arrow on the right side of the oscilloscope). When set to “Falling”, the trigger fires when the selected channel’s waveform passes below the horizontal trigger line.

'''Source channel''': This sets the channel that will be used to detect an edge event, and then fire the trigger.

'''Arm''': If this is toggled active, the trigger is armed and will next fire when the edge event next occurs (in “Single” sweep type), or when the edge event next occurs and the oscilloscope has already drawn to the edge of the screen (in “Repeat” sweep type).

You can drag the arrow at the bottom of the oscilloscope to the left or right, in order to set where you want the edge event to be displayed once the trigger fires. This allows you to change how much data before or after the edge event you would like to view.

Oscilloscope

2019-05-14T13:01:58Z

DanielM: /* Introduction */

<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>

__TOC__

==Introduction==

Flowcode includes a 4 channel, fully triggering oscilloscope, 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 [[Ghost_Technology#In-Circuit-Test_.28Pin_monitoring.29 | In-Circuit-Test]]. It can also be used in simulation mode, though timing of signals is not accurate when using simulation.

[[File:Oscilloscope.jpg|border|x800px|Oscilloscope window showing a sine wave]]

Please note that the oscilloscope is not designed for viewing extremely high-speed signals (in the microsecond range) over long time periods. For this type of analysis, we recommend the [[Using_the_Data_Scope|Data Recorder]].

==How to use==

To setup a channel, simply click the Add data button for a channel, and select the relevant analog or digital, then click ok. When simulation starts, you’ll begin to see data appear on the screen. If you are using Matrix hardware, you can click the Ghost button when simulation is not running in order to view live data from the microcontroller. You can add up to 4 channels simultaneously, and hide existing channels by unchecking the check boxes.

You can drag the arrow that represents the 0V base line for a channel, in order to modify the waveform’s vertical offset. You can also click use the combo-boxes underneath the grid in order to modify the height of channels.

In order to modify the time, use the drop-down combo box on the bottom-left, labelled “Scale”. To tell Flowcode that your board is operating in 3V3 voltage mode, use the checkbox at the top of the window.

==Triggering==

Triggering allows the view of the data to remain fixed until an event happens. Click “Use Trigger” to activate trigger mode. You will see the data disappear until the trigger is armed. The settings for modifying the trigger behaviour are as follows:

'''Sweep type''': If set to “Single”, then after firing, the oscilloscope will draw to the right end of the screen and then maintain the image until the trigger is re-armed. If set to “Repeat”, the trigger will remain armed after firing, and after the oscilloscope has drawn to the right end of the screen, re-fire when the event next occurs.

'''Edge event''': When set to “Rising”, the trigger fires when the selected channel’s waveform passes above the horizontal trigger line (set using the arrow on the right side of the oscilloscope). When set to “Falling”, the trigger fires when the selected channel’s waveform passes below the horizontal trigger line.

'''Source channel''': This sets the channel that will be used to detect an edge event, and then fire the trigger.

'''Arm''': If this is toggled active, the trigger is armed and will next fire when the edge event next occurs (in “Single” sweep type), or when the edge event next occurs and the oscilloscope has already drawn to the edge of the screen (in “Repeat” sweep type).

You can drag the arrow at the bottom of the oscilloscope to the left or right, in order to set where you want the edge event to be displayed once the trigger fires. This allows you to change how much data before or after the edge event you would like to view.