LabNation Wiki - User contributions [en]

Logic Analyser

2017-12-16T02:18:00Z

JamesNewton: Bringing this little lost page up to date and linking to the main page.

The logic analyser functions display the state of the 8 input pins on the [[AUX_connector_pinout|AUX Connector]] and can be used as triggers. Decoders are being added for common signal protocols.

See: [[Logic_Analyzer_functionality]]

Creating your own Protocol Decoder

2015-12-08T17:13:39Z

JamesNewton: No mention was made of the development environment.

The decoder framework has been created from the ground up with extensibility in mind. In case you want to use your own decoder in the SmartScope app, simply follow these steps (details info further down):
* Install and learn to use [http://www.visualstudio.com Microsoft Visual Studio]
* Download the Decoder source package containing the sample decoder project
*Copy an existing decoder file
*Change the metadata, like Name and RequiredInputWaveforms
* Code the logic of your decoder in the Process method
* Compile the project
* Copy the resulting .dll file into the same folder as the SmartScope app
And voila, your custom decoder will show up nicely in the list of available processors!
= Download the Decoder source package =
Get the code from [https://github.com/labnation/decoders github] - Some elementary instructions are available there as well
* Clone it to a local repo if you know how
* Otherwise, simply click the "Download ZIP" button on the right menu to download the full package as a .zip file
Next, run the Protobuild.exe program to create the solution files for your platform. In case of Windows, this will create (amongst other) the Decoders.Windows.sln file.

= Start from an existing decoder file=
Open up the Decoder project (windows: by double-clicking the Decoders.Windows.sln file).
 Next, click on the “DecoderI2C.cs” file in the Solution Explorer at the top-right of your screen. Hit Ctrl+C and Ctrl+V to duplicate that file. Select the resulting “DecoderI2C - Copy.cs” file, right-click -> Rename to give the file a meaningful name. In the example below, "MyCustomDecoder.cs" was chosen.

 [[File:CD1.png]]

 Double-click on the file to open up its contents. Change the original class name DecoderI2C to a name suiting your filename.

 [[File:CD2.png]]

= Define the metadata =
Time to focus on the code. Just underneath the class name, you’ll notice the Description which contains a couple of properties which define everything about your decoder the SmartScope app needs to know, except the decoding itself. Change all of them to suite your new decoder’s needs:
 [[File:CD4.png]]
* '''Name:''' This is how your decoder will be presented by the SmartScope app in the list of available decoders.
* '''Abbreviation:''' Max 4 characters describing your decoder. These will be printed inside the indicator of your decoder wave at the very left of the SmartScope app.
* '''Author:''' Your name. Not used at the moment, sorry about that.
* '''VersionMajor & VersionMinor:''' In case multiple decoders with same name are detected, these field allow the SmartScope app to detect which instance it the most recent one.
* '''InputWaveformTypes:''' Here you define how many input waveforms your decoder requires, and which type of data they need to contain. This is done by using a Dictionary, linking the name of the wave to the type of required contents.
'''Optional:'''
* ''InputWaveformExpectedToggleRates:'' The SmartScope app contains functionality which allows to automatically map the correct input signal to the correct input of your Decoder. To allow this, you only need to specify which input sources you expect to toggle the most. This is done by a dictionary, specifying the expected ToggleRate for each input waveform.
* ''Parameters:'' Allows the user to specify additional paramteres, such as ActiveLow/ActiveHigh, or values such as Baud rates etc. See the DecoderUART for an example on this.
* ''ContextMenuOrder:'' Allows you to specify the order in which the InputWaves and Parameters will be presented in the Context menu of the SmartScope app. See the OperatorAnalogMath for an example on this.

= Code your logic =
With all preparations done, it’s time to focus on the fun stuff. Head to the Process method, which has 3 arguments:
* '''inputWaveforms:''' this is a list of arrays, containing all waveforms you specified above in the RequiredInputWaveforms property.
* '''parameters:''' this is a dictionary containing all paramters you specified above in the RequiredInputWaveforms property.
* '''samplePeriod:''' in case your decoder requires absolute timestamps, this argument is for you. By multiplying this value by the indices of your input arrays, you can find the exact time between them. In case your decoder would require 2 digital waveform and 1 waveform containing voltages (floats), you should have this:

'''NOTE:''' if you specify bool, the SmartScope app will pick up all logic channels and analog channels (the app will convert them to binary values for you). If you specify float, the SmartScope app will pick up analog channels only. In case you want to build a decoder which consumes the output of another decoder, you can also specify DecoderOutput as input type.

Now you’ll notice the inputWaveforms is a Dictionary, providing a typeless Array for each input you require. Before you can use the actual values inside the Arrays, you’ll want to cast them to Arrays containing the type your defined earlier. In case of our previous example, this is how this would be done:
==Decoder output==
Now you can go ahead and implement your decoder. The output of your decoder must be an array of DecoderOutput elements.

You can have 2 types of DecoderOutput objects:
* the '''DecoderOutputValue''' serves to contain a decoded value (such as an address byte)
* the '''DecoderOutputEvent''' is used to store a decoded event (such as a Start condition).

When creating a DecoderOutput object, the first and second arguments you have to specify indicate the indices at which the visualization should start and end. The third argument allows you to specify the color in which it should be rendered to the screen.

Once you have defined the list of outputs for your decoder, transform it into an array and send it back to the SmartScope app, which will gladly display your newly created waveform. Additionally, other decoders will now also be able to select your decoder as input source.

= Compile the project =
Select Build -> Build solution (F6), solve any bugs and iterate until all bugs have been squashed.
= Move the .dll file to the right folder =
Once compilation is finished, find the resulting .dll file. You can find the location where the .dll is being generated by right-clicking on your project (Decoders in the screenshot at the top of this page), selecting Properties, selecting Build in the menu on the left and then checking the Output path on the bottom of the page presented.

Copy or move that .dll file (Decoders.dll in case of this example) to the following folder:

{| class="wikitable"
! Platform
! Path
|-
| Mac || /Users/<username>/LabNation/Plugins
|-
| Linux || ~/LabNation/Plugins
|-
| Windows || <My Documents>/LabNation/Plugins
|-
| Android || <sd-card>/LabNation/Plugins
|-
| iOS || See section below regarding DropBox
|}

Now when you restart the SmartScope app, it should automagically pick up your new decoder and list it as available decoder!
 [[File:CD3.png]]
==Using DropBox to transfer the dll to your tablet/phone==
For all platforms, you can access a DLL file over DropBox. To do so, in the app go to Menu -> Add decoder -> Fetch from dropbox. If never done before, this will authenticate to DropBox and create all folders required. Next, on your PC you can save the DLL file to \Dropbox\Apps\LabNation SmartScope\Plugins. All DLL files you place here can now be accessed from all your devices over dropbox!

= Debugging your decoder in real-time =
Even though your project passes compilation successfully, there are many reasons why your decoder might not produce the desired result, or even cause the SmartScope throw an error message. The best way to figure out why, is to put a breakpoint in your code so you can step through your code while live data is being fed in.
In order to do so, simply put a breakpoint at the first line of code of your Process method, as shown below. Start up the SmartScope app, and add your decoder.

 [[File:CD5.png]]

 Now usually you would expect the code to break at your breakpoint, but not in this case as the SmartScope app is using your compiled .dll, and not the code source you’re looking at. But no worries, we just need to let Visual Studio know that your source is exactly the same as the .dll which is currently being executed. To do so, select Debug -> Attach to process. Select SmartScope.exe from the list, and hit Attach. You should see that the SmartScope app is being halted, and your breakpoint is active now. Step through your code using F11 and F10 as you would debug any other program!

Talk:Creating your own Protocol Decoder

2015-03-11T18:01:11Z

JamesNewton: Created page with "Development here uses Visual Studio? Wouldn't it be good to add a note to that effect with a link to: https://www.visualstudio.com/ Will it work with the free versions? How a..."

Development here uses Visual Studio? Wouldn't it be good to add a note to that effect with a link to:
https://www.visualstudio.com/

Will it work with the free versions? How about the cloud based online version?

Talk:Changelog

2015-03-11T17:51:27Z

JamesNewton: Versions for apps

These version numbers don't match the version numbers of the Arduino App. Can you add the app version numbers in future?

Talk:Using the Protocol Decoders

2015-02-24T01:44:54Z

JamesNewton: Created page with "What version has these decoders in it?"

What version has these decoders in it?

Arbitrary Waveform Generator (AWG)

2015-01-18T21:59:20Z

JamesNewton: /* AWG pin location */

The SmartScope has an Arbitrary waveform generator, capable of generating signals between the [0V, 3.3V] voltage range at a sample rate of 100MS/s.
= AWG pin location =
The signal generated by the AWG is presented on the 3rd-left pin on the bottom row of the [[AUX_connector_pinout|'''AUX connector''']], as shown in the following image: 
[[File:AWGoutput.png|400px]] 
Please keep in mind that you always should bridge 2 wires between 2 separate devices. In this case:
* The AWG output signal
* The ground, so both devices have the same reference voltage. (0V means the same on both devices)
In the image above, you can see the AWG pin is surrounded by 2 ground pins, either of which you can use to connect to the other device.

= Configuring the AWG using pre-defined waves =
= Configuring the AWG using csv files =
'''NOTE''': This only works with a SmartScope connected. Otherwise, the side menu won't contain an AWG item
If you haven't used dropbox with the SmartScope
# Tap sidemenu > AWG > Upload from dropbox
# The app will tell you it doesn't have permission to dropbox and ask for it by sending you off to the dropbox website
# Grant access and return to the app
# The app now creates the AWG folder and will inform you that this new folder is empty.

#Generate a CSV file using the [[Media:awg_worksheet.xlsx|AWG excel worksheet]]. A sample CSV can be found for a [[Media:sine.csv|sine]] and [[Media:block.csv|block]] wave.
#Drop your CSV file in the AWG folder (<dropbox>/'''Apps'''/LabNation SmartScope/AWG) using a file manager
#In the app, tap sidemenu > AWG > Upload from dropbox
#You should now be able to choose the CSV file

Connectors pinout

2015-01-18T21:58:11Z

JamesNewton:

<pre>
1 8

_____________________________________
| _______--________ |
| | . . . . . . . . | |
| -- === | . . . . . . . . | |
| `-----------------' |
`-------------------------------------'
9 16
</pre>
1:8 [[Logic Analyser]]<7:0>
9 External Trigger
10 GND
11 [[Arbitrary_Waveform_Generator_(AWG)|AWG Output]]
12 GND
13:16 Digital out <0:3>

Main Page

2015-01-18T21:57:27Z

JamesNewton: /* Software User Manual */

==Installing the software and connecting the SmartScope==
All of our software installations contain a '''demonstration mode''', which is automatically activated in case no SmartScope is connected. This allows everyone to evaluate the software.
* Windows
** [[Install the SmartScope software on Windows]]
** [[Connect the SmartScope to a Windows pc]]
* OSX
** [[Install the SmartScope software on OSX]]
** [[Connect the SmartScope to a Mac]]
* Linux
** [[Install the SmartScope software on Ubuntu]]
** [https://www.lab-nation.com/forum/software/topics/installing-smartscope-on-fedora-linux Install the SmartScope software on Fedora]
** [[Connect the SmartScope to a Linux box]]
* Android
** [https://www.lab-nation.com/faq/27 Is my Android device compatible?]
** [[Install the SmartScope software on Android]]
** [[Connect the SmartScope to an Android phone/tablet]]
* iOS
** [[Install SmartScope on iOS with Cydia]]
** [[Connect the SmartScope to an iOS phone/tablet]]

==Software User Manual==
* Global topics
** [[Main menu]]
** [[Cue card]]
* [[Oscilloscope functionality]]
* [[Arbitrary Waveform Generator (AWG)]]

==Hardware==
* [//www.lab-nation.com/specs Hardware specs]
* [[Using the micro USB connector]]
* [[AUX connector pinout]]
* [https://www.lab-nation.com/forum/hardware/topics/probe-calibration-howto Probe calibration]

==General==
* [[Known issues]]
* [[Changelog]]
* [http://www.lab-nation.com Lab-Nation main page]
* [https://www.lab-nation.com/forum/ User Support Forum]
* [[Suggestion box]]

==Other==
* [[Sandbox]]

Arbitraty Waveform Generator (AWG)

2015-01-18T21:57:02Z

JamesNewton: JamesNewton moved page Arbitraty Waveform Generator (AWG) to Arbitrary Waveform Generator (AWG): Misspelling of Arbitrary as Arbitraty in page name.

#REDIRECT [[Arbitrary Waveform Generator (AWG)]]

Arbitrary Waveform Generator (AWG)

2015-01-18T21:57:02Z

JamesNewton: JamesNewton moved page Arbitraty Waveform Generator (AWG) to Arbitrary Waveform Generator (AWG): Misspelling of Arbitrary as Arbitraty in page name.

The SmartScope has an Arbitrary waveform generator, capable of generating signals between the [0V, 3.3V] voltage range at a sample rate of 100MS/s.
= AWG pin location =
The signal generated by the AWG is presented on the 3rd-left pin on the bottom row of the '''AUX connector''', as shown in the following image: 
[[File:AWGoutput.png|400px]] 
Please keep in mind that you always should bridge 2 wires between 2 separate devices. In this case:
* The AWG output signal
* The ground, so both devices have the same reference voltage. (0V means the same on both devices)
In the image above, you can see the AWG pin is surrounded by 2 ground pins, either of which you can use to connect to the other device.
= Configuring the AWG using pre-defined waves =
= Configuring the AWG using csv files =
'''NOTE''': This only works with a SmartScope connected. Otherwise, the side menu won't contain an AWG item
If you haven't used dropbox with the SmartScope
# Tap sidemenu > AWG > Upload from dropbox
# The app will tell you it doesn't have permission to dropbox and ask for it by sending you off to the dropbox website
# Grant access and return to the app
# The app now creates the AWG folder and will inform you that this new folder is empty.

#Generate a CSV file using the [[Media:awg_worksheet.xlsx|AWG excel worksheet]]. A sample CSV can be found for a [[Media:sine.csv|sine]] and [[Media:block.csv|block]] wave.
#Drop your CSV file in the AWG folder (<dropbox>/'''Apps'''/LabNation SmartScope/AWG) using a file manager
#In the app, tap sidemenu > AWG > Upload from dropbox
#You should now be able to choose the CSV file

Arbitrary Waveform Generator (AWG)

2015-01-18T21:54:47Z

JamesNewton: You guys know that "Arbitraty" is spelled "Arbitrary"? I've corrected the page, but can't see how to rename a page...

The SmartScope has an Arbitrary waveform generator, capable of generating signals between the [0V, 3.3V] voltage range at a sample rate of 100MS/s.
= AWG pin location =
The signal generated by the AWG is presented on the 3rd-left pin on the bottom row of the '''AUX connector''', as shown in the following image: 
[[File:AWGoutput.png|400px]] 
Please keep in mind that you always should bridge 2 wires between 2 separate devices. In this case:
* The AWG output signal
* The ground, so both devices have the same reference voltage. (0V means the same on both devices)
In the image above, you can see the AWG pin is surrounded by 2 ground pins, either of which you can use to connect to the other device.
= Configuring the AWG using pre-defined waves =
= Configuring the AWG using csv files =
'''NOTE''': This only works with a SmartScope connected. Otherwise, the side menu won't contain an AWG item
If you haven't used dropbox with the SmartScope
# Tap sidemenu > AWG > Upload from dropbox
# The app will tell you it doesn't have permission to dropbox and ask for it by sending you off to the dropbox website
# Grant access and return to the app
# The app now creates the AWG folder and will inform you that this new folder is empty.

#Generate a CSV file using the [[Media:awg_worksheet.xlsx|AWG excel worksheet]]. A sample CSV can be found for a [[Media:sine.csv|sine]] and [[Media:block.csv|block]] wave.
#Drop your CSV file in the AWG folder (<dropbox>/'''Apps'''/LabNation SmartScope/AWG) using a file manager
#In the app, tap sidemenu > AWG > Upload from dropbox
#You should now be able to choose the CSV file

Logic Analyser

2015-01-18T02:49:43Z

JamesNewton: drrr I can spell!

The logic analyser functions are currently limited to displaying the state of the 8 input pins on the [[AUX_connector_pinout|AUX Connector]] and setting triggering options on each pin. In the future, Decoders will be added for common signal protocols.

Logic Analyser

2015-01-18T02:49:21Z

JamesNewton: Start page.

Connectors pinout

2015-01-18T02:44:55Z

JamesNewton: Linking to the pages that describe what these pins do.

<pre>
1 8

_____________________________________
| _______--________ |
| | . . . . . . . . | |
| -- === | . . . . . . . . | |
| `-----------------' |
`-------------------------------------'
9 16
</pre>
1:8 [[Logic Analyser]]<7:0>
9 External Trigger
10 GND
11 [[Arbitraty_Waveform_Generator_(AWG)|AWG Output]]
12 GND
13:16 Digital out <0:3>

Connectors pinout

2015-01-18T02:30:26Z

JamesNewton: Added the little notch in the top of the connector.

<pre>
1 8

_____________________________________
| _______--________ |
| | . . . . . . . . | |
| -- === | . . . . . . . . | |
| `-----------------' |
`-------------------------------------'
9 16

1:8 Logic Analyser<7:0>
9 External Trigger
10 GND
11 AWG output
12 GND
13:16 Digital out <0:3>
</pre>

Connect the SmartScope to an Android phone/tablet

2014-12-04T18:31:42Z

JamesNewton: Oops. Didn't realize you guys were selling the OTG cable. Feel free to remove the links to other sources if you like.

# Connect the central miniB port of the SmartScope using a regular miniB USB cable [[File:miniB.jpg|400px]] 
# Connect this USB cable to your Android device using an [http://en.wikipedia.org/wiki/USB_On-The-Go OTG cable]. Sources: [https://www.lab-nation.com/store Lab-Nation] (recommended) Others: [http://www.monoprice.com/Product?c_id=108&cp_id=10833&cs_id=1083314&p_id=9724&seq=1&format=2 MonoPrice], [http://www.walmart.com/search/?query=OTG WallMart]. [[File:connectToAndroid.jpg|600px]] 
# Start the SmartScope app, and go solve your problems!! [[File:iphone5.PNG|600px]]

Main Page

2014-12-04T18:09:07Z

JamesNewton: /* Software */ Edited for clarity

==Software==
All of our software installations contain a '''demonstration mode''', which is automatically activated in case no SmartScope is connected. This allows everyone to evaluate the software.
* Windows
** [[Install the SmartScope software on Windows]]
** [[Connect the SmartScope to a Windows pc]]
* OSX
** [[Install the SmartScope software on OSX]]
** [[Connect the SmartScope to a Mac]]
* Linux
** [[Install the SmartScope software on Ubuntu]]
** [https://www.lab-nation.com/forum/software/topics/installing-smartscope-on-fedora-linux Install the SmartScope software on Fedora]
** [[Connect the SmartScope to a Linux box]]
* Android
** [[Install the SmartScope software on Android]]
** [[Connect the SmartScope to an Android phone/tablet]]
* iOS
** [[Install SmartScope on iOS with Cydia]]
** [[Connect the SmartScope to an iOS phone/tablet]]

==Hardware==
* [//www.lab-nation.com/specs Hardware specs]
* [[Using the micro USB connector]]
* [https://www.lab-nation.com/forum/hardware/topics/logic-analyzer-pinout AUX connector pinout diagram]
* [https://www.lab-nation.com/forum/hardware/topics/probe-calibration-howto Probe calibration]

==General==
* [[Known issues]]
* [[Changelog]]
* [http://www.lab-nation.com Lab-Nation main page]
* [https://www.lab-nation.com/forum/ User Support Forum]

==Other==
* [[Sandbox]]

Main Page

2014-12-04T18:06:19Z

JamesNewton: /* Software */ Adding link to user supplied instructions for installing on Fedora

==Software==
All of our software installations contain a '''demonstration mode''', which is automatically activated in case no SmartScope is connected. This allows everyone to evaluate the software.
* Windows
** [[Install the SmartScope software on Windows]]
** [[Connect the SmartScope to a Windows pc]]
* OSX
** [[Install the SmartScope software on OSX]]
** [[Connect the SmartScope to a Mac]]
* Linux
** [[Install the SmartScope software on Ubuntu]] [https://www.lab-nation.com/forum/software/topics/installing-smartscope-on-fedora-linux Fedora]
** [[Connect the SmartScope to a Linux box]]
* Android
** [[Install the SmartScope software on Android]]
** [[Connect the SmartScope to an Android phone/tablet]]
* iOS
** [[Install SmartScope on iOS with Cydia]]
** [[Connect the SmartScope to an iOS phone/tablet]]

==Hardware==
* [//www.lab-nation.com/specs Hardware specs]
* [[Using the micro USB connector]]
* [https://www.lab-nation.com/forum/hardware/topics/logic-analyzer-pinout AUX connector pinout diagram]
* [https://www.lab-nation.com/forum/hardware/topics/probe-calibration-howto Probe calibration]

==General==
* [[Known issues]]
* [[Changelog]]
* [http://www.lab-nation.com Lab-Nation main page]
* [https://www.lab-nation.com/forum/ User Support Forum]

==Other==
* [[Sandbox]]

Known issues

2014-12-04T18:02:59Z

JamesNewton: Assuming we should send people to the forum for support...

{| class="wikitable"
! Platform
! Issue
! Workaround
|-
| iOS || App crashes when disconnecting smartscope || Close and restart app
|-
| iOS || The attached accessory uses too much power (iPad 1)|| Power the SmartScope through its micro usb port Low-power mode to fix this problem coming soon
|}

If your issue isn't listed here, please search the [https://www.lab-nation.com/forum/ User Support Forum]

Main Page

2014-12-04T18:02:02Z

JamesNewton: Adding links to main page and support forum.

==Software==
All of our software installations contain a '''demonstration mode''', which is automatically activated in case no SmartScope is connected. This allows everyone to evaluate the software.
* Windows
** [[Install the SmartScope software on Windows]]
** [[Connect the SmartScope to a Windows pc]]
* OSX
** [[Install the SmartScope software on OSX]]
** [[Connect the SmartScope to a Mac]]
* Linux
** [[Install the SmartScope software on Ubuntu]]
** [[Connect the SmartScope to a Linux box]]
* Android
** [[Install the SmartScope software on Android]]
** [[Connect the SmartScope to an Android phone/tablet]]
* iOS
** [[Install SmartScope on iOS with Cydia]]
** [[Connect the SmartScope to an iOS phone/tablet]]

==Hardware==
* [//www.lab-nation.com/specs Hardware specs]
* [[Using the micro USB connector]]
* [https://www.lab-nation.com/forum/hardware/topics/logic-analyzer-pinout AUX connector pinout diagram]
* [https://www.lab-nation.com/forum/hardware/topics/probe-calibration-howto Probe calibration]

==General==
* [[Known issues]]
* [[Changelog]]
* [http://www.lab-nation.com Lab-Nation main page]
* [https://www.lab-nation.com/forum/ User Support Forum]

==Other==
* [[Sandbox]]

Connect the SmartScope to a Linux box

2014-12-04T17:50:42Z

JamesNewton: Start page. Connection hardware should be the same on Linux as on Windows.

# Connect the SmartScope's central miniB USB port with a miniB cable to your PC, as shown in the image below: [[File:ConnectToPc.jpg|600px]]

You may need to change permissions to allow communication on that USB port.

Connect the SmartScope to an Android phone/tablet

2014-12-04T17:22:16Z

JamesNewton: Adding link to explain what an OTG cable is and provide some sources.

# Connect the central miniB port of the SmartScope using a regular miniB USB cable [[File:miniB.jpg|400px]] 
# Connect this USB cable to your Android device using an [http://en.wikipedia.org/wiki/USB_On-The-Go OTG cable]. Sources: [http://www.monoprice.com/Product?c_id=108&cp_id=10833&cs_id=1083314&p_id=9724&seq=1&format=2 MonoPrice], [http://www.walmart.com/search/?query=OTG WallMart]. [[File:connectToAndroid.jpg|600px]] 
# Start the SmartScope app, and go solve your problems!! [[File:iphone5.PNG|600px]]

Install the SmartScope software on Android

2014-12-04T17:08:22Z

JamesNewton: Start page with link to app.

The app is available in the play store:
https://play.google.com/store/apps/details?id=com.lab_nation.smartscope