[[PageOutline(2-5, Table of Contents, floated)]]

= Installation guide =

''This installation guide refers to the current git release of pKNyX.''

== Git ==

'''pKNyX''' uses [http://git-scm.com/ git] as VCS. To get the latest sources files:

{{{
$ git clone https://framagit.org/fma38/pKNyX.git
}}}

== Dependencies ==

pKNyX is entirely written in python, and uses some third-party modules:

 * [http://pythonhosted.org/APScheduler APSscheduler] -- Advanced Python Scheduler
 * [http://pyserial.sourceforge.net pySerial] -- serial bus access for python

== Build source archive ==

Use the following command at '''pKNyX''' root:

{{{
$ python setup.py sdist
}}}

The archive will be build in the {{{dist/}}} directory.

== Core ==

=== !Gnu/Linux ===

From source archive:

{{{
$ pip install pKNyX-<version>.tar.gz
}}}

== Configuration ==

The current implementation of '''pKNyX''' needs a '''!KnxIp Router''' to work. There are 2 main reasons for that:

 - simplify the KNX stack implementation, as all '''pKNyX''' needs to do is send/receive multicast IP frames;
 - allow to spread as many device (= process) as we want.

As nobody really has such router device, just use [http://www.auto.tuwien.ac.at/~mkoegler/index.php/eibd eibd], and configure it as a router, with the -R option.

To check if it works, use the '''{{{pknyx-group.py}}}''' utility:

{{{
$ pknyx-group.py read 1/1/1
0
}}}

If you get a warning like:

{{{
No answer from that Group Address (1/1/1)
}}}

You may need to adjust some config on your network. See the [[FAQ]].

For the rest, remember that pKNyX is a framework, so you need to code your own application. See the [[Tutorial|tutorial]] page and the complete [http://www.pknyx.org/static/api/index.html API].