Difference between revisions of "Windows"

From sigrok
Jump to navigation Jump to search
(→‎Status: More device status entries.)
(40 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[File:sigrok windows.png|right|thumb|320px|sigrok-qt on Windows]]
[[File:Pulseview win jtag.png|right|thumb|320px|[[PulseView]] on Windows]]


== Status ==
== Windows installers ==


We intend to fully support all major operating systems in sigrok, including Windows. However, we're not quite there, yet. Various portability issues need to be addressed still. The tables below list the current Windows status of the various hardware drivers.
We provide nightly Windows installers for [[sigrok-cli]] and [[PulseView]]. Please test and [http://sigrok.org/bugzilla/ report] any issues you encounter.


=== Supported ===
'''Downloads:'''
* [http://sigrok.org/jenkins/job/sigrok-cross-mingw/buildtype=static,debugtype=release,platform=cross-i686-w64-mingw32/lastSuccessfulBuild/artifact/pulseview-NIGHTLY-32bit-static-release-installer.exe pulseview-NIGHTLY-32bit-static-release-installer.exe] ([http://sigrok.org/jenkins/job/sigrok-cross-mingw/buildtype=static,debugtype=debug,platform=cross-i686-w64-mingw32/lastSuccessfulBuild/artifact/pulseview-NIGHTLY-32bit-static-debug-installer.exe debug build])
* [http://sigrok.org/jenkins/job/sigrok-cross-mingw/buildtype=static,debugtype=release,platform=cross-i686-w64-mingw32/lastSuccessfulBuild/artifact/sigrok-cli-NIGHTLY-32bit-static-release-installer.exe sigrok-cli-NIGHTLY-32bit-static-release-installer.exe] ([http://sigrok.org/jenkins/job/sigrok-cross-mingw/buildtype=static,debugtype=debug,platform=cross-i686-w64-mingw32/lastSuccessfulBuild/artifact/sigrok-cli-NIGHTLY-32bit-static-debug-installer.exe debug build])
 
<gallery widths="120px" heights="70px" perrow="5">
File:Sigrok windows installer1.jpg
File:Sigrok windows installer2.jpg
File:Sigrok windows installer3.jpg
File:Sigrok windows installer4.jpg
File:Sigrok windows installer5.jpg
</gallery>
 
== Drivers ==
 
In order to use [[libsigrok]] (via a sigrok frontend) on Windows, you need to install the proper driver for the respective device.
 
=== COM/serial/RS232 driver ===
 
If your device is connected through a (virtual) COM port, libsigrok doesn't need a special driver. Please install the driver as provided by the manufacturer. If you are unsure, you can check if your device appears at the "Ports (COM&LPT)" section of the Windows Device Manager.
 
=== Device specific USB driver ===
 
The device specific USB driver shipped with the vendor software is '''not''' going to work in almost all cases. You will need to install the '''WinUSB''' driver.
 
For installing the '''WinUSB''' driver you can use the [http://zadig.akeo.ie/ Zadig] executable from the [https://github.com/pbatard/libwdi/wiki libwdi] project. There are two versions, one for Windows XP ('''zadig_xp.exe'''), and another one for all other (Vista or higher) supported Windows versions ('''zadig.exe'''). Both 32 and 64 bit Windows versions are supported.
The [[sigrok-cli]] and [[PulseView]] installers ship with both Zadig executable files for convenience and they're available from the Windows "Start" menu (the Zadig *.exe files themselves are located in the installation directory of the respective application).
 
If you already installed the vendor driver previously, you need to run Zadig and switch to the '''WinUSB''' driver (see above). There's no need to uninstall or deactivate the vendor driver manually, Zadig will handle all of this.
 
See also the [https://github.com/pbatard/libwdi/wiki/Zadig Zadig wiki page] for more information.
 
== Firmware ==
 
The Windows installers ship with all firmware files that are either open-source or where we have permission from the vendor to distribute them. Some devices will need other firmware which we cannot redistribute though. See the wiki page for the respective device on how you can extract those firmware files from the vendor's software.
 
You'll need to copy the extracted files into the '''firmware''' subfolder of the respective installation directory of [[sigrok-cli]] or [[Pulseview]], e.g. '''C:\Program Files\sigrok\sigrok-cli\firmware''' or '''C:\Program Files\sigrok\PulseView\firmware'''.
 
== Example files ==
 
The Windows installers ship with example dump files (from our [[Example dumps|sigrok-dumps]] repository), which are located in the '''examples''' subdirectory of the install directory of [[sigrok-cli]] and [[PulseView]].
 
These files can be used to conveniently test various frontend features and [[protocol decoders]], and so on.
 
== Limitations and TODOs ==
 
The table below lists some of the known remaining issues.


{| border="0" style="font-size: smaller" class="alternategrey sigroktable"
{| border="0" style="font-size: smaller" class="alternategrey sigroktable"
|-
|-
!Logic analyzer
!Driver/component
!Windows status
!Windows status
|-
|-
| [[ASIX SIGMA]]/[[ASIX SIGMA|SIGMA2]]
| openbench-logic-sniffer
| bgcolor="lime" | Should work fine using libftdi + libusb-0.1-win32 (not runtime-tested yet, though).
| bgcolor="orange" | The OLS (and other compatible devices such as Buspirate) only work once in [[PulseView]] or [[sigrok-cli]] (sometimes not at all), subsequent acquisitions fail ([http://sigrok.org/bugzilla/show_bug.cgi?id=638 bug #638]).
|-
 
| [[ChronoVu LA8]]
| bgcolor="lime" | Works fine using libftdi + libusb-0.1-win32.
|-
| Demo driver
| bgcolor="lime" | Works fine.
|-
| [[IKALOGIC ScanaPLUS]]
| bgcolor="lime" | Works fine using libftdi + libusb-0.1-win32.
|-
| [[ZEROPLUS Logic Cube LAP-C(16032)]]
| bgcolor="lime" | Works fine using libusb-1.0.
|-
| [[ZEROPLUS LAP-16128U ]]
| bgcolor="lime" | Should works fine using libusb-1.0 (not runtime-tested yet, though).
|}
|}


=== Work in progress ===
See [http://sigrok.org/bugzilla/buglist.cgi?query_format=advanced&resolution=---&op_sys=Windows&list_id=2400 the current list of Windows issues] in Bugzilla for the full list.


{| border="0" style="font-size: smaller" class="alternategrey sigroktable"
== FAQ ==
|-
 
!Logic analyzer
=== I cannot start sigrok-cli or PulseView: error Oxc0150002 ===
!Windows status
 
|-
This happens if you don't have the [http://www.microsoft.com/de-de/download/details.aspx?id=29 Microsoft Visual C++ 2008 Redistributable Package] installed. Usually this is already installed on most machines since various other software packages also need this. If you didn't yet install it (or no other software package automatically installed it for you) you will see the '''Oxc0150002''' error and [[sigrok-cli]] and/or [[PulseView]] will not start.
| [[ARMFLY Mini-Logic ]]
 
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
The root cause for this is that the above download will install the otherwise missing file '''msvcr90.dll''' (and possibly others) which is required for running sigrok frontends. The requirement is imposed by '''python32.dll''' to be more specific, which we use/need for running [[protocol decoders]].
|-
 
| [[Braintechnology USB Interface V2.x]]
Please download the [http://www.microsoft.com/de-de/download/details.aspx?id=29 Microsoft Visual C++ 2008 Redistributable Package] and install it, that should fix the issue and allow you to start [[sigrok-cli]] and/or [[PulseView]].
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
 
|-
=== My device is not found or usable (USB/driver/firmware/hardware issues) ===
| [[Braintechnology USB-LPS]]
 
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
If a [[libsigrok]] frontend such as [[sigrok-cli]] or [[PulseView]] doesn't seem to find your device, that could have multiple reasons:
|-
 
| [[CWAV USBee SX]]
* You need to place the proper firmware and/or FPGA bitstream file(s) for your device (if any) into the respective directory where the frontend expects them. See [[Windows#Firmware|above]] for details.
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
* You need to install the correct vendor driver and/or use Zadig to assign the WinUSB driver to your device. See [[Windows#Drivers|above]] for details.
|-
* Be careful into which USB port you plug the device. Windows assigns drivers to USB devices based on their serial number, and as a fallback (if the device doesn't have a USB serial number) it assigns drivers per USB port. That means (for example) that if you assigned the WinUSB driver using Zadig while your device was attached to a certain physical USB port, that assignment will '''not''' be available when you plug the same device into '''another''' USB port! You'll have to do the WinUSB driver assignment '''again''' (using Zadig) for that new USB port!
| [[Dangerous Prototypes Buspirate]]
* If you use certain inexpensive FX2-based logic analyzers, please do '''not''' use the USB cable that they shipped with. Those USB cables seem to be of a consistently '''very''' bad quality and cause all kinds of strange issues. Use another USB cable of which you are sure that it is working well.
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).
 
|-
== Building from source ==
| [[EE Electronics ESLA100]]
 
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
'''Note:''' This should generally not be necessary for users, please just use the provided [[Windows#Windows_installers|nightly installers]] (see above).
|-
 
| [[IKALOGIC Scanalogic-2]]
=== Cross-compile using MXE ===
| bgcolor="red" | HID-based, we need to use HIDAPI.
 
|-
If you ''really'' want to build from source, we recommend you use the [http://sigrok.org/gitweb/?p=sigrok-util.git;a=tree;f=cross-compile/mingw sigrok-cross-mingw] script from the sigrok-util repository (that uses [http://mxe.cc/ MXE]) to cross-compile the Windows binaries on a Linux system.
| [[Lcsoft Mini Board]]
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
|-
| [[Logic Shrimp]]
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).
|-
| [[MCU123 Saleae Logic clone]]
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
|-
| [[MCU123 USBee AX Pro clone]]
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
|-
| [[Openbench Logic Sniffer]]
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).
|-
| [[Robomotic BugLogic 3]]
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
|-
| [[Robomotic MiniLogic]]
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
|-
| [[Saleae Logic]]
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
|-
| [[Link Instruments MSO-19‎]]
| bgcolor="orange" | Doesn't compile due to libudev dependency. TODO: Make libudev optional.


|- bgcolor="#6699ff"
Native builds are generally '''not''' supported by us! Yes, they can work in theory (see below), but it means a lot of hassle compared to a cross-compile using the above script, and native builds are not really well-tested by us.
!Mixed-signal oscilloscope
!Windows status
|-
| [[ARMFLY AX-Pro]]
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
|-
| [[EE Electronics ESLA201A]]
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
|-
| [[XZL_Studio AX]]
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.


|- bgcolor="#6699ff"
=== Native build using MSYS2 ===
!Oscilloscope
!Windows status
|-
| [[Fluke ScopeMeter 199B]]
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).
|-
| [[Hantek DSO-2090]]
| bgcolor="red" | Various issues need to be sorted out<sup>1</sup>.
|-
| [[Rigol DS1052E]]
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).
|-
| [[Rigol DS1102E]]
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).


|- bgcolor="#6699ff"
If you ''do'' want to build the sigrok subprojects natively on a Windows system (instead of using the cross-compile method, see above) we recommend you use [http://sourceforge.net/projects/msys2/ MSYS2]. More information is available on the [http://sourceforge.net/p/msys2/wiki/MSYS2%20introduction/ MSYS2 introduction] and the [http://sourceforge.net/p/msys2/wiki/MSYS2%20installation/ MSYS2 installation] pages.
!Multimeter
!Windows status
|-
| serial-dmm based DMMs
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).


|- bgcolor="#6699ff"
Please read our [http://sigrok.org/gitweb/?p=sigrok-util.git;a=blob;f=cross-compile/msys2/README README] for details on how to set up MSYS2 in general, how to install the sigrok dependencies, and so on.
!Sound level meter
!Windows status
|-
| [[CEM DT-8852]]
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).
|-
| [[Colead SL-5868P]]
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).
|-
| [[Kecheng KC-330B]]
| bgcolor="yellow" | Untested. libusb-1.0 based, might work.
|-
| [[Tondaj SL-814]]
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).


|- bgcolor="#6699ff"
Then, use our [http://sigrok.org/gitweb/?p=sigrok-util.git;a=blob;f=cross-compile/msys2/sigrok-native-msys2 sigrok-native-msys2] script to build all required software components.
!Thermometer
!Windows status
|-
| [[Lascar Electronics EL-USB-2]]
| bgcolor="yellow" | Untested. libusb-1.0 based, might work.
|-
| [[MIC 98581]]
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).
|-
| [[MIC 98583]]
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).
|-
| [[UNI-T UT325]]
| bgcolor="red" | HID-based, we need to use HIDAPI.
|-
| [[Voltcraft K204]]
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).


|- bgcolor="#6699ff"
'''Status''':
!Hygrometer
* This is still work in progress, not all parts are fully working, tested, or supported yet. Patches welcome!
!Windows status
* MSYS2 currently doesn't ship with all packages we want. E.g. the following are missing: autoconf-archive, libftdi1, librevisa, SWIG >= 3.0.8.
|-
* '''Working''': libusb (special branch), libserialport, libsigrok, libsigrokcxx, libsigrokdecode, sigrok-firmware, sigrok-firmware-fx2lafw.
| [[Lascar Electronics EL-USB-2]]
* '''NOT yet working''': libsigrok Python/Ruby/Java bindings, sigrok-cli, sigrok-cli NSIS installer, PulseView, PulseView NSIS installer.
| bgcolor="yellow" | Untested. libusb-1.0 based, might work.
|-
| [[MIC 98583]]
| bgcolor="orange" | Serial port portability fixes required (partially implemented, but unfinished).


|- bgcolor="#6699ff"
=== Native build using the old MinGW+MSYS ===
!Datalogger
!Windows status
|-
| [[Lascar Electronics EL-USB-CO]]
| bgcolor="yellow" | Untested. libusb-1.0 based, might work.


|}
Not supported by us. Please use one of the methods described above.


<sup>1</sup> There are various problems with the current sigrok and libusb-1.0 code on Windows that need to be fixed. Among other things, running poll()/select() on FDs is not possible on Windows, neither does libusb_get_pollfds() work, and renumeration of Cypress FX2(LP) based devices has issues that need to be investigated.
=== Native build using Cygwin ===


== Self-extracting installers ==
Not supported by us. Please use one of the methods described above.


Work in progress. We don't provide pre-built installers for [[sigrok-cli]] and [[PulseView]] right now, but will do so in the near future, when a few issues have been sorted out.
=== Native build using Borland/Embarcadero C++ Builder ===


<gallery widths="120px" heights="70px" perrow="5">
Not supported by us. Please use one of the methods described above.
File:Sigrok windows installer1.jpg
File:Sigrok windows installer2.jpg
File:Sigrok windows installer3.jpg
File:Sigrok windows installer4.jpg
File:Sigrok windows installer5.jpg
</gallery>


== Building from source ==
=== Native build using Microsoft Visual Studio ===


See [[Windows/Building]].
Not supported by us. Please use one of the methods described above.

Revision as of 01:08, 7 September 2016

PulseView on Windows

Windows installers

We provide nightly Windows installers for sigrok-cli and PulseView. Please test and report any issues you encounter.

Downloads:

Drivers

In order to use libsigrok (via a sigrok frontend) on Windows, you need to install the proper driver for the respective device.

COM/serial/RS232 driver

If your device is connected through a (virtual) COM port, libsigrok doesn't need a special driver. Please install the driver as provided by the manufacturer. If you are unsure, you can check if your device appears at the "Ports (COM&LPT)" section of the Windows Device Manager.

Device specific USB driver

The device specific USB driver shipped with the vendor software is not going to work in almost all cases. You will need to install the WinUSB driver.

For installing the WinUSB driver you can use the Zadig executable from the libwdi project. There are two versions, one for Windows XP (zadig_xp.exe), and another one for all other (Vista or higher) supported Windows versions (zadig.exe). Both 32 and 64 bit Windows versions are supported. The sigrok-cli and PulseView installers ship with both Zadig executable files for convenience and they're available from the Windows "Start" menu (the Zadig *.exe files themselves are located in the installation directory of the respective application).

If you already installed the vendor driver previously, you need to run Zadig and switch to the WinUSB driver (see above). There's no need to uninstall or deactivate the vendor driver manually, Zadig will handle all of this.

See also the Zadig wiki page for more information.

Firmware

The Windows installers ship with all firmware files that are either open-source or where we have permission from the vendor to distribute them. Some devices will need other firmware which we cannot redistribute though. See the wiki page for the respective device on how you can extract those firmware files from the vendor's software.

You'll need to copy the extracted files into the firmware subfolder of the respective installation directory of sigrok-cli or Pulseview, e.g. C:\Program Files\sigrok\sigrok-cli\firmware or C:\Program Files\sigrok\PulseView\firmware.

Example files

The Windows installers ship with example dump files (from our sigrok-dumps repository), which are located in the examples subdirectory of the install directory of sigrok-cli and PulseView.

These files can be used to conveniently test various frontend features and protocol decoders, and so on.

Limitations and TODOs

The table below lists some of the known remaining issues.

Driver/component Windows status
openbench-logic-sniffer The OLS (and other compatible devices such as Buspirate) only work once in PulseView or sigrok-cli (sometimes not at all), subsequent acquisitions fail (bug #638).

See the current list of Windows issues in Bugzilla for the full list.

FAQ

I cannot start sigrok-cli or PulseView: error Oxc0150002

This happens if you don't have the Microsoft Visual C++ 2008 Redistributable Package installed. Usually this is already installed on most machines since various other software packages also need this. If you didn't yet install it (or no other software package automatically installed it for you) you will see the Oxc0150002 error and sigrok-cli and/or PulseView will not start.

The root cause for this is that the above download will install the otherwise missing file msvcr90.dll (and possibly others) which is required for running sigrok frontends. The requirement is imposed by python32.dll to be more specific, which we use/need for running protocol decoders.

Please download the Microsoft Visual C++ 2008 Redistributable Package and install it, that should fix the issue and allow you to start sigrok-cli and/or PulseView.

My device is not found or usable (USB/driver/firmware/hardware issues)

If a libsigrok frontend such as sigrok-cli or PulseView doesn't seem to find your device, that could have multiple reasons:

  • You need to place the proper firmware and/or FPGA bitstream file(s) for your device (if any) into the respective directory where the frontend expects them. See above for details.
  • You need to install the correct vendor driver and/or use Zadig to assign the WinUSB driver to your device. See above for details.
  • Be careful into which USB port you plug the device. Windows assigns drivers to USB devices based on their serial number, and as a fallback (if the device doesn't have a USB serial number) it assigns drivers per USB port. That means (for example) that if you assigned the WinUSB driver using Zadig while your device was attached to a certain physical USB port, that assignment will not be available when you plug the same device into another USB port! You'll have to do the WinUSB driver assignment again (using Zadig) for that new USB port!
  • If you use certain inexpensive FX2-based logic analyzers, please do not use the USB cable that they shipped with. Those USB cables seem to be of a consistently very bad quality and cause all kinds of strange issues. Use another USB cable of which you are sure that it is working well.

Building from source

Note: This should generally not be necessary for users, please just use the provided nightly installers (see above).

Cross-compile using MXE

If you really want to build from source, we recommend you use the sigrok-cross-mingw script from the sigrok-util repository (that uses MXE) to cross-compile the Windows binaries on a Linux system.

Native builds are generally not supported by us! Yes, they can work in theory (see below), but it means a lot of hassle compared to a cross-compile using the above script, and native builds are not really well-tested by us.

Native build using MSYS2

If you do want to build the sigrok subprojects natively on a Windows system (instead of using the cross-compile method, see above) we recommend you use MSYS2. More information is available on the MSYS2 introduction and the MSYS2 installation pages.

Please read our README for details on how to set up MSYS2 in general, how to install the sigrok dependencies, and so on.

Then, use our sigrok-native-msys2 script to build all required software components.

Status:

  • This is still work in progress, not all parts are fully working, tested, or supported yet. Patches welcome!
  • MSYS2 currently doesn't ship with all packages we want. E.g. the following are missing: autoconf-archive, libftdi1, librevisa, SWIG >= 3.0.8.
  • Working: libusb (special branch), libserialport, libsigrok, libsigrokcxx, libsigrokdecode, sigrok-firmware, sigrok-firmware-fx2lafw.
  • NOT yet working: libsigrok Python/Ruby/Java bindings, sigrok-cli, sigrok-cli NSIS installer, PulseView, PulseView NSIS installer.

Native build using the old MinGW+MSYS

Not supported by us. Please use one of the methods described above.

Native build using Cygwin

Not supported by us. Please use one of the methods described above.

Native build using Borland/Embarcadero C++ Builder

Not supported by us. Please use one of the methods described above.

Native build using Microsoft Visual Studio

Not supported by us. Please use one of the methods described above.