View source for Mac OSX

Purpose of this set is to get Domoticz running on OS X systems.
(El Capitan Tested)

'''This page explains how to build it from source with Homebrew, you can also get ready to run version from http://www.domoticz.com/downloads/ but note that Z-Wave is NOT included in that version, you have to compile it yourself to use Z-Wave or use the unofficial binary. '''


=Preparing your OS X for Domoticz=

==Get Xcode command line tools==
Compiling requires Xcode, which can be installed with command line:
<syntaxhighlight lang="bash">
xcode-select --install
</syntaxhighlight>
It is suggested to installed the Xcode app from the app store (around 3,5 GB). In case you install it, run the app at first once and accept the guarantee terms.
<br>Prior to Domoticz installation, mac can be prepared alternatively with Homebrew or MacPorts.<br>
==Homebrew==
===Homebrew installation===
Use commande line:
<syntaxhighlight lang="bash">
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
</syntaxhighlight>
In case you have Homebrew already installed make sure is up to date via command line:
<syntaxhighlight lang="bash">
brew update
brew upgrade
</syntaxhighlight>

===X11===
It is recommended to install X11.app, via XQuartz: [http://xquartz.macosforge.org/landing/]

===Homebrew installation check===
Prior to install libraries, it is better to check Homebrew installation with command:
<syntaxhighlight lang="bash">
brew doctor
</syntaxhighlight>
In case you get the warning:
<br>"You have an outdated version of /usr/bin/install_name_tool installed. This will cause binary package installations to fail. This can happen if you install osx-gcc-installer or RailsInstaller. To restore it, you must reinstall OS X or restore the binary from the OS packages."
<br>do not go ahead until you getit  solved. It can happen that some app/tool had modified the "install_name_tool". You can find the proper version of "install_name_tool" for OS X Mavericks (working also for Yosemite) on [https://github.com/cinic/install-name-tool]. Just download it and overwrite on folder /usr/bin/. Run again "brew doctor" and warning should disappear. 

===Install necessary libraries===

Run following command lines in the terminal:

<syntaxhighlight lang="bash">
brew install cmake
brew install boost --with-python
brew install boost-python
brew install libusb
brew install libusb-compat
brew install zlib
brew install openssl
brew link openssl --force
brew install python3
brew linkapps python3
brew install lua
luarocks install luasocket
</syntaxhighlight>

<syntaxhighlight lang="bash">
export LDFLAGS=-L/usr/local/opt/openssl/lib
export CPPFLAGS=-I/usr/local/opt/openssl/include
</syntaxhighlight>

==Installing the Stable Binary==

Use the Terminal and execute the commands below note that '''Z-Wave is not included''' you have to compile that yourself:

 mkdir ~/domoticz
 cd ~/domoticz
 curl -O <nowiki>https://releases.domoticz.com/releases/release/domoticz_osx_x86_64.tgz</nowiki>
 tar -zxvf domoticz_osx_x86_64.tgz
 rm domoticz_osx_x86_64.tgz

continue at section: Make Domoticz startup at boot time (Also needed for Web Update)

==Installing the Beta Binary==

Use the Terminal and execute the commands below note that '''Z-Wave is not included''' you have to compile that yourself:

 mkdir ~/domoticz
 cd ~/domoticz
 curl -O <nowiki>https://releases.domoticz.com/releases/beta/domoticz_osx_x86_64.tgz</nowiki>
 tar -zxvf domoticz_osx_x86_64.tgz
 rm domoticz_osx_x86_64.tgz

continue at section: Make Domoticz startup at boot time

==Installing from Source==

Please read carefully!!!

===Download Domoticz source===
Move to the father folder where you want to install Domoticz and run:
<syntaxhighlight lang="bash">
git clone https://github.com/domoticz/domoticz.git domoticz
</syntaxhighlight>

===Compile OpenZWave===
You can skip this section about z-wave if you do not use it.
If you use Z-Wave the brew version is a very old and z-wave is not standard included in domoticz on OSX so you have to compile it to use Z-Wave, compile it in the same '''root folder''' as domoticz (thus not inside the domoticz folder).

<syntaxhighlight lang="bash">
git clone https://github.com/OpenZWave/open-zwave.git
ln -s open-zwave open-zwave-read-only
cd open-zwave
make
make install
cd ..
</syntaxhighlight>

Most people make the mistake to clone open-zwave into the domoticz folder. 


 '''DO NOT DO THAT, SERIOUSLY DO NOT DO THAT'''

Please ensure the SIP protection is disabled on newer OSX (El Capitan, Sierra)

'''Please make sure that your folder look like this in the terminal'''

<syntaxhighlight lang="bash">
pluto.local:~ Trixwood$ls
domoticz		open-zwave-read-only
open-zwave		
</syntaxhighlight>

With the domoticz and the open-zwave, open-zwave-read-only in the same folder

===Compile Domoticz===
Before you begin compilling domoticz. 

====Speed Up====

Search and replace in main/Scheduler.cpp and in main/SQLHelper.cpp the following: 
 "sleep_seconds(1)" to "sleep_milliseconds(50);"

For old systems. If this value is not working for you, try 100 milliseconds or change it back to 1 second.

[https://www.domoticz.com/forum/viewtopic.php?t=11619#p83823]

====LUA Fix====
Edit lua/src/luaconf.h

<syntaxhighlight lang="python">
#if defined(LUA_USE_MACOSX)
#define LUA_USE_POSIX
#define LUA_USE_DLOPEN      /* does not need -ldl */
#define LUA_USE_READLINE   /* needs an extra library: -lreadline */
#define LUA_USE_STRTODHEX   /* assume 'strtod' handles hex formats */
#define LUA_USE_AFORMAT      /* assume 'printf' handles 'aA' specifiers */
#define LUA_USE_LONGLONG   /* assume support for long long */
#endif
</syntaxhighlight>

removed the #if defines and #endif to force right compiler options...

<syntaxhighlight lang="python">
#define LUA_USE_POSIX
#define LUA_USE_DLOPEN      /* does not need -ldl */
#define LUA_USE_READLINE   /* needs an extra library: -lreadline */
#define LUA_USE_STRTODHEX   /* assume 'strtod' handles hex formats */
#define LUA_USE_AFORMAT      /* assume 'printf' handles 'aA' specifiers */
#define LUA_USE_LONGLONG   /* assume support for long long */
</syntaxhighlight>

[https://www.domoticz.com/forum/viewtopic.php?f=6&t=11766&p=84568&hilit=compiling#p84566]

====Compile====

Compile domoticz with commands:<br>

<syntaxhighlight lang="bash">
cd domoticz
cmake -DCMAKE_BUILD_TYPE=Release  -DPYTHON_INCLUDE_DIR=/usr/local/Cellar/python3/3.5.2_3/Frameworks/Python.framework/Versions/3.5/Headers -DPYTHON_LIBRARY=/usr/local/Cellar/python3/3.5.2_3/Frameworks/Python.framework/Versions/3.5/lib/libpython3.5.dylib CMakeLists.txt
make
</syntaxhighlight>

If the Python version installed by Homebrew changes the Python version numbers will need to be adjusted accordingly.  To get a clean version run 

<syntaxhighlight lang="bash">sudo make install</syntaxhighlight> 

unfortunate it is written to the default /opt/domoticz with root owner so you have to move it and own it
 
<syntaxhighlight lang="bash">
sudo mv /opt/domoticz ~
sudo chown -R yourusername:staff ~/domoticz
</syntaxhighlight>

where yourusername is your user name.

====OpenSSL====
If you are having problems with openssl, see 
[http://www.domoticz.com/forum/viewtopic.php?f=6&t=2581&p=56799#p56799 forum topic] or this
[https://www.domoticz.com/forum/viewtopic.php?f=6&t=11766&p=90088#p90088 forum topic]

==Compiling Domoticz with OpenZWave support for MacOS Sierra (10.12)==

===Preparations===
Follow instructions above for Xcode, Homebrew and X11. Note: if you have compiled openzwave befoe, you’ll see quite a number of warnings when you run <tt>brew doctor</tt> (notably ’unbrewed’ OpenZWave dylib and header files).

===Installing libraries===
<syntaxhighlight lang="bash">
brew install cmake
brew install boost
brew install boost-python
brew install libusb
brew install libusb-compat
brew install openssl
brew link openssl --force
brew install python3
brew linkapps python3
brew install lua
luarocks install luasocket
</syntaxhighlight>
Installing and linking openssl comes with a number of warnings and caveats which do not prevent you from completing the finalcompilation of Domoticz successfully.

===Download Domoticz and OpenZwave source===
Move to the folder where you want to create the Domoticz folder (eg within your home directory). 
<syntaxhighlight lang="bash">
git clone https://github.com/domoticz/domoticz.git domoticz
</syntaxhighlight>
The open-zwave directory has to be created in the same folder (next to the domoticz folder).
<syntaxhighlight lang="bash">
git clone https://github.com/OpenZWave/open-zwave.git
</syntaxhighlight>

===Compile OpenZwave===
Before compiling OpenZWave make sure you disable MacOS’s ''System Integrity Protection'' (SIP) (and to return it to its original state after the compilation is completed). This is only required for OpenZWave. Now compile OpenZwave. Please note you are still required to use <tt>sudo</tt> for <tt>make install</tt> even while you have disabled SIP.
<syntaxhighlight lang="bash">
ln -s open-zwave open-zwave-read-only
cd open-zwave
make
sudo make install
cd ..
</syntaxhighlight>

===Compile Domoticz===
You can follow trixwood’s instruction to modify the Domoticz source  above (<tt>sleep</tt> and <tt>LUA</tt>) but this is not required for a successful compilation. The export statements below replace the original export statements listed above for <tt>LDFLAGS</tt> and <tt>CPPFLAGS</tt>.
<syntaxhighlight lang="bash">
cd domoticz
export OPENSSL_ROOT_DIR=/usr/local/opt/openssl/
export OPENSSL_INCLUDE_DIR=/usr/local/opt/openssl/include/
cmake -DCMAKE_BUILD_TYPE=Release -DPYTHON_INCLUDE_DIR=/usr/local/Cellar/python3/3.6.1/Frameworks/Python.framework/Versions/3.6/Headers -DPYTHON_LIBRARY=/usr/local/Cellar/python3/3.6.1/Frameworks/Python.framework/Versions/3.6/lib/libpython3.6m.dylib -DUSE_PYTHON_PLUGINS=NO CMakeLists.txt
make
</syntaxhighlight>
Note you may have to change the references to the Python folders in the cmake statement depending on your Python version. Simply follow the folders in the Cellar directory to find the correct folders for you.<br>
Now you should have the domoticz executable in the Domoticz folder.<br><br>
MacOS Sierra Instructions above are a summary of a slightly more detailed description posted in the [http://domoticz.com/forum/viewtopic.php?p=118725#p118725 Domoticz forum]

=Domoticz start and stop=
You can start and stop Domticz via terminal or via script.

==From Terminal==
This solution will keep terminal busy.
===Start Domoticz===
Enter domoticz folder and run:
<syntaxhighlight lang="bash">
./domoticz
</syntaxhighlight>
The open Safari and go to webpage: http://localhost:8080

===Stop Domoticz===
From terminal just press ctrl+c

==Make Domoticz startup at boot time==
Starting and stopping a OSX script/app can best be done by using launchctl<br>
Create a file named com.domoticz.server.plist in /Library/LaunchAgents:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
        <key>Disabled</key>
        <false/>
        <key>Label</key>
        <string>com.domoticz.server</string>
        <key>ProgramArguments</key>
        <array>
          <string>/opt/domoticz/domoticz</string>
                <string>-www</string>
                <string>8080</string>
                <string>-log</string>
                <string>/var/log/domoticz.log</string>
                <string>-loglevel</string>
                <string>normal,status,error</string>
        </array>
        <key>OnDemand</key>
        <false/>
        <key>KeepAlive</key>
        <true/>
        <key>RunAtLoad</key>
        <true/>
        <key>WorkingDirectory</key>
        <string>/opt/domoticz</string>
</dict>
</plist>
</syntaxhighlight>

Install the launch script with: 

<syntaxhighlight lang="bash">
launchctl load /Library/LaunchAgents/com.domoticz.server.plist
</syntaxhighlight>

and start it:

<syntaxhighlight lang="bash">
launchctl start com.domoticz.server
</syntaxhighlight>

Or use a GUI interface: [http://www.soma-zone.com/LaunchControl/ LaunchControl]

=Not Working=
These items will not work tested version 3.48-3.52

*[https://www.domoticz.com/forum/viewtopic.php?f=6&t=11766&p=90080#p84564 Updater]
*[https://www.domoticz.com/forum/viewtopic.php?f=6&t=11766&p=90080#p84568 Motherboard Sensors]
*System Alive Checker (Ping)
*[https://www.domoticz.com/wiki/Voltcraft_CO-20 Volcraft CO20 USB]

Also note that using sockets in LUA is broken in the release version, to fix that compile it yourself :-)

=Usefull Links=

===iMessage Notification===
iMessage Notification [https://www.domoticz.com/forum/viewtopic.php?f=23&t=11870&p=85334#p85334 iMessage]

===Airplay / iTunes===

[https://www.domoticz.com/forum/viewtopic.php?f=38&t=9190]

===Voice Commands: Talk to Domoticz===
Voice Commands: Talk to Domoticz (offline, make sure you check that box!) [https://support.apple.com/en-us/HT202584 Voice Recognition] [https://support.apple.com/kb/PH21513?viewlocale=en_US&locale=en_NZ Voice Commands]

===Text To Speech (TTS)===
Text To Speech (TTS) [http://osxdaily.com/2011/07/25/how-to-add-new-voices-to-mac-os-x/ Text To Speech Config] &
[http://www.techradar.com/how-to/computing/apple/terminal-101-making-your-mac-talk-with-say-1305649 Text To Speech Command Line]

===Camera Motion Detection=== 
Camera Motion Detection: You can split one camera into 4, making it possible to detect walk direction with on cheap usb camera, since it uses applescript you can easily communicate with domoticz
[http://www.bensoftware.com/securityspy/ SecuritySpy] [bit.ly/1Tw3Vgj .] and for some fine-tunning [https://itunes.apple.com/nl/app/webcam-settings/id533696630?mt=12 Webcam Settings]
[https://www.domoticz.com/forum/viewtopic.php?f=23&t=11908&p=85624&hilit=walk+direction#p85624 Zone & Walking Direction Motion Sensors]

===Scripts===
Scripts [https://itunes.apple.com/app/eventscripts/id525319418?mt=12 Event Scripts]

[[Category:Domoticz]]
[[Category:Manual]]
[[Category:Install]]
[[Category:TTS]]
[[Category:Speech Recognition]]
[[Category:Z-Wave]]
[[Category:OSX]]