-------------------------------------------------------------------------------
owsasclient-php                                                      2015-05-15
v1.0.1
===============================================================================


Overview
--------

This package contains PHP software for performing socket-based client
communication with the 1-Wire Automation Server:

* OwsasClient: client communication with the 1-Wire server.
* Example programs and webpages.

The package can be used on Linux and Windows.

The package is available in two archive formats:

* owsasclient-php-1.0.1.tar.gz
* owsasclient-php-1.0.1.zip

They both contain the same files. Format .tar.gz is meant for use in Linux as
it stores the correct file permissions.


Unpacking
---------

The package includes PHP programs that can be run at the command line and web-
sites that can be deployed under Apache or other web server. It's a good idea
to unpack the package into a directory that your web server exposes for HTTP
access, for example directory /var/www/ in Linux.


Unpack in Windows
-----------------

1. Copy the .zip file to the target directory.

2. Right-click on the .zip file and extract locally. You may have to install an
   extraction tool first if the file explorer doesn't offer an extraction
   command.


Unpack in Linux
---------------

1. Copy the .tar.gz file to the target directory.

2. Unpack the archive file:

        $ tar -xzp -f owsasclient-php-1.0.1.tar.gz

   If you're running a graphical interface like GNOME or KDE, the system likely
   offers an interactive way to unpack the archive (usually by right-clicking
   on the archive file).


Requirements
------------

The software has been tested on Linux and Windows in these environments:

* PHP v5.2.17, Windows 32-bit, ApacheFriends XAMPP version 1.7.7.
* PHP v5.3.25, Linux Ubuntu 10.04 64-bit, Apache.

Make sure the following extensions are enabled in your installation of PHP:

* sockets


Using the software
------------------

The "OwsasClient" directory contains the PHP software for client communication
with the 1-Wire Automation Server. The software comprises a set of classes.

The "examples" directory contains directories with PHP programs and sample
websites:

* Directory "cli" contains programs to be run from the command line interface.

* The other directories contain websites.


The Big Demo
------------

Directory examples/big_demo/ contains an extensive demonstration website.

To get started, you've to make sure the configuration settings are correct. You
can find the configuration settings in file session.php. Adjust the following
settings:

- $baseurl

That's it. Now point your web browser to the directory in order to open up the
demo website.

The demo includes file SessionContext_Local.php by default from session.php.
The included PHP script implements the following features:

- A session context that uses cookies and stores PHP session data in local
  files.

- An example 1-Wire set-up that you can easily adjust to your needs.

- The following user accounts:

    - username: "frank"  password: (none)
    - username: "jane"   password: (none)

The idea is that you modify SessionContext_Local.php for your own purposes. You
can also create your own implementation of the session context, for example, if
you want to put information in a MySQL database.


References
----------

1-Wire Automation Software:
http://www.axiris.eu/en/index.php/1-wire/1-wire-automation-software

Support forum:  http://www.axiris.eu/forum/

Axiris website:  http://www.axiris.eu/

Please refer to the user manuals (pdf) of the 1-Wire Automation Software for
more information.