Difference between revisions of "Mac OS X"

From sigrok
Jump to navigation Jump to search
(36 intermediate revisions by 11 users not shown)
Line 1: Line 1:
[[File:sigrok macosx.png|right|thumb|320px|sigrok-gui on Mac OS X]]
This page describes how to build the sigrok subprojects on Mac OS X.


This page describes how to build sigrok on Mac OS X.
== Binary Disk Images (DMG) ==


== Building ==
We provide nightly Mac OS X disk image files (DMG) for [[PulseView]] (require OSX 10.9 Mavericks or higher). Please test and [http://sigrok.org/bugzilla/ report] any issues you encounter.


These instructions have been tested on a clean Mac OS X 10.6.8 install.
<gallery widths="120px" heights="70px" perrow="5">
File:Pulseview macosx dmg.png
File:Pulseview macosx.png
</gallery>


=== Requirements ===
Downloads:


Install MacPorts, follow the guide on [http://www.macports.org/install.php macports.org] (this step will require Xcode on your machine, which is also a dependency to build sigrok).
* [http://sigrok.org/jenkins/job/sigrok-native-macosx/platform=native-macosx/lastSuccessfulBuild/artifact/cross-compile/macosx/build_app/PulseView_nightly.dmg PulseView_nightly.dmg] (64bit)


Install Qt, download qt-mac-opensource-4.7.4.dmg from [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x qt.nokia.com] (Only needed for sigrok-qt).
The files are self-contained and ship with all required libraries, decoders and all freely distributable firmware files.


TODO: Install GTK+ libs and dependencies for sigrok-gtk.
If you need to provide additional firmware files, you can copy them to any of the standard paths where [[libsigrok]] searches for firmware files. See [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=README.devices README.devices] for details.


Install git:
== Building from source ==


$ '''sudo port install git-core'''
'''Note:''' This should generally not be necessary for users, please just use the provided [[Mac_OS_X#Binary_Disk_Images_.28DMG.29|nightly installers]] (see above).


This will also pull in a bunch of dependencies required by git-core (and some of them also by sigrok).
=== Building from source using Homebrew ===


Install libusb, libzip and libftdi, the sigrok build dependencies:
'''Linking pulseview fails on osx with glib 2.58 [https://sigrok.org/bugzilla/show_bug.cgi?id=1281 Bug 1281]. glib 2.56.1 is known to work.'''


$ '''sudo port install libusb'''
'''Currently the sigrok-util script expects to see qt version 5.5, which has been removed from main homebrew repository as of 2018-10-01. See [https://sigrok.org/bugzilla/show_bug.cgi?id=1304 Bug #1304]. You can edit the sigrok-native-macosx script to use a different qt version. qt versions >5.9.3 might be affected by widget repaint issues, see [https://sigrok.org/bugzilla/show_bug.cgi?id=1305 bug 1305]'''
$ '''sudo port install libzip'''
$ '''sudo port install libftdi'''


Building [[libsigrok]]:


$ '''git clone git://sigrok.org/libsigrok'''
This is the recommended way of building sigrok from source on Mac OS X.
$ '''cd libsigrok'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''
$ '''cd ..'''


Building [[libsigrokdecode]]:
Install [http://brew.sh Homebrew] (not covered here, see Homebrew docs for details) and all sigrok build dependencies:


$ '''git clone git://sigrok.org/libsigrokdecode'''
<small>
  $ '''cd libsigrokdecode'''
  $ '''brew install libzip libftdi libusb libtool glibmm doxygen autoconf-archive sdcc python3 boost qt pkg-config cmake glib autoconf automake swig check'''
$ '''./autogen.sh'''
</small>
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''
$ '''cd ..'''


Then you need to build the chosen user interfaces (cli, qt or gtk).
Clone [http://sigrok.org/gitweb/?p=sigrok-util.git sigrok-util]:


For building [[sigrok-cli]] (the command-line interface for sigrok):
<small>
$ '''git clone git://sigrok.org/sigrok-util'''
$ '''cd sigrok-util/cross-compile/macosx'''
$ '''./sigrok-native-macosx'''
</small>


$ '''git clone git://sigrok.org/sigrok-cli'''
This script will download all the code, compile and install it in the '''$HOME/sr_macosx''' directory.
$ '''cd sigrok-cli'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''
$ '''cd ..'''


For building [[PulseView]]:
To conveniently use the tools you need to export the additional path.


  $ '''git clone git://sigrok.org/pulseview'''
<small>
$ '''cd pulseview'''
  $ '''export PATH=$HOME/sr_macosx/bin:$PATH'''
$ '''cmake .'''
</small>
$ '''make'''
$ '''sudo cp pulseview /your/install/path'''
$ '''cd ..'''


For building [[sigrok-gtk]] ('''Note:''' The GTK+ GUI is not yet usable!):
=== Building from source using MacPorts ===


$ '''git clone git://sigrok.org/sigrok-gtk'''
Not supported by us. Please use one of the methods described above.
$ '''cd sigrok-gtk'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''
$ '''cd ..'''


For building [[sigrok-qt]] ('''Note:''' The Qt GUI is not yet usable!):
While it shouldn't be too much work to adapt the [http://sigrok.org/gitweb/?p=sigrok-util.git;a=blob;f=cross-compile/macosx/sigrok-native-macosx sigrok-native-macosx] script to also work for [https://www.macports.org/ MacPorts], this is currently not recommended or supported. Patches to support both Homebrew and MacPorts in that script are welcome, though.


$ '''git clone git://sigrok.org/sigrok-qt'''
=== Building from source manually ===
$ '''cd sigrok-qt'''
$ '''PKG_CONFIG_PATH=/usr/local/lib/pkgconfig qmake -spec macx-g++'''
$ '''make'''
$ '''sudo make install'''
$ '''cd ..'''


If you get warnings claiming potential symbol conflicts when running qmake, you are likely not invoking '''qmake-qt4'''. Try running '''qmake-qt4''' to force the correct version.
Not supported by us. Please use one of the methods described above.


Open the sigrok-gui application just built:
While this is technically possible if you know what you're doing, we don't recommend or support it. It's a lot easier to use the provided DMG files or build using the [http://sigrok.org/gitweb/?p=sigrok-util.git;a=blob;f=cross-compile/macosx/sigrok-native-macosx sigrok-native-macosx] script (see above).


$ '''open -a sigrok-gui.app'''
=== Building from source using existing Homebrew packages/taps ===


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


* To build on Snow Leopard (10.6) you need to use the [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x Cocoa (32bit and 64bit) Qt libraries]. Don't use the default download link on that page but the one you can find further down the page.
There are various Homebrew recipies for sigrok, e.g. in [https://github.com/Homebrew/homebrew-science homebrew-science] or in [https://github.com/rene-dev/homebrew-sigrok rene-dev's homebrew-sigrok repo]. However, none of them are officially maintained or recommended or supported by us, and they might be incomplete and/or outdated, YMMV.
* Currently we are using [http://www.macports.org/ macports] for the libusb dependency and are relying on the fact that macports are installed in /opt/local.
* See also [http://xor-gate.org/writings/sigrok-osx-scratchbuild Wafelijzer's efforts to build Mac OS X binaries].
** Python framework incorrect build for OS X [http://bugs.python.org/issue15353 issue 15353]
 
== TODO ==
 
* Find a sane way to bundle libusb with the sigrok.app.
* Include an icon with the app.
* [[Mac OS X/Dylib|Set the relative paths in the binary's and DyLibs]]
* [[Mac OS X/Universal| Building universal DyLibs and binaries]]
* Bundle the dynamic libraries with [http://macdylibbundler.sourceforge.net MacDylibBundler]
 
== Resources ==
 
* [http://doc.trolltech.com/qq/qq09-mac-deployment.html Qt: Deploying Applications on Mac OS X]
* [http://developer.apple.com/library/mac/#documentation/Porting/Conceptual/PortingUnix/compiling/compiling.html Porting UNIX/Linux Applications to Mac OS X]
* [http://cairographics.org/end_to_end_build_for_mac_os_x CairoGraphics - End to End build for Mac OS X]
* [http://developer.apple.com/mac/library/documentation/CoreFoundation/Conceptual/CFBundles/Introduction/Introduction.html#//apple_ref/doc/uid/10000123i-CH1-SW1 Documentation about bundles]
* [http://stackoverflow.com/questions/1596945/building-osx-app-bundle Stackoverflow - Building OSX App Bundle]

Revision as of 15:58, 11 October 2018

This page describes how to build the sigrok subprojects on Mac OS X.

Binary Disk Images (DMG)

We provide nightly Mac OS X disk image files (DMG) for PulseView (require OSX 10.9 Mavericks or higher). Please test and report any issues you encounter.

  • Pulseview macosx dmg.png
  • Pulseview macosx.png

Downloads:

The files are self-contained and ship with all required libraries, decoders and all freely distributable firmware files.

If you need to provide additional firmware files, you can copy them to any of the standard paths where libsigrok searches for firmware files. See README.devices for details.

Building from source

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

Building from source using Homebrew

Linking pulseview fails on osx with glib 2.58 Bug 1281. glib 2.56.1 is known to work.

Currently the sigrok-util script expects to see qt version 5.5, which has been removed from main homebrew repository as of 2018-10-01. See Bug #1304. You can edit the sigrok-native-macosx script to use a different qt version. qt versions >5.9.3 might be affected by widget repaint issues, see bug 1305


This is the recommended way of building sigrok from source on Mac OS X.

Install Homebrew (not covered here, see Homebrew docs for details) and all sigrok build dependencies: 

$ brew install libzip libftdi libusb libtool glibmm doxygen autoconf-archive sdcc python3 boost qt pkg-config cmake glib autoconf automake swig check

Clone sigrok-util: 

$ git clone git://sigrok.org/sigrok-util
$ cd sigrok-util/cross-compile/macosx
$ ./sigrok-native-macosx

This script will download all the code, compile and install it in the $HOME/sr_macosx directory.

To conveniently use the tools you need to export the additional path. 

$ export PATH=$HOME/sr_macosx/bin:$PATH

Building from source using MacPorts

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

While it shouldn't be too much work to adapt the sigrok-native-macosx script to also work for MacPorts, this is currently not recommended or supported. Patches to support both Homebrew and MacPorts in that script are welcome, though.

Building from source manually

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

While this is technically possible if you know what you're doing, we don't recommend or support it. It's a lot easier to use the provided DMG files or build using the sigrok-native-macosx script (see above).

Building from source using existing Homebrew packages/taps

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

There are various Homebrew recipies for sigrok, e.g. in homebrew-science or in rene-dev's homebrew-sigrok repo. However, none of them are officially maintained or recommended or supported by us, and they might be incomplete and/or outdated, YMMV.

Retrieved from "https://sigrok.org/w/index.php?title=Mac_OS_X&oldid=13775"