Fork me on GitHub

GCE Electronics Ipx800

Submitted by Mauro Cicolella on 2012, August 20 - 22:15
Your rating: None Average: 5 (1 vote)
Driver
Development Status: 
Beta Version
Developer: 
Mauro Cicolella
Tested on: 
Linux
Windows
Download Link: 
Download Link: 
Download Link: 
Download Link: 
Short Description: 

It enables communication between Freedomotic and Ipx800 boards by gce-electronics.com

How it works

With this plugin Freedomotic can communicate with an ethernet relay board by gce-electronics.  For more details visit the official site.

How to install this plugin

Please follow the instruction for sensors and actuators on the user tutorial

How to configure this plugin

The ipx800-manifest.xml file contains all the plugin configuration parameters. It's possible to control more than one board setting its parameters into a specific <tuple></tuple> block.

Here an example of configuration file:

<config>
    <properties>
        <property name="description"    value="Communicates with ipx800 board"/>
        <property name="protocol.name"  value="ipx800"/>
        <property name="category"       value="protocol"/>
        <property name="short-name"     value="ipx800"/>
        <property name="address-delimiter" value=":"/>
        <property name="startup-time"   value="on load"/>
        <property name="change-state-relay-url" value="leds.cgi?led="/>
        <property name="send-pulse-relay-url" value="rlyfs.cgi?rlyf="/>
        <property name="get-status-url" value="status.xml"/>
     </properties>
    <tuples>
        <tuple>
            <property name="alias" value="default"/>
            <property name="ip-to-query" value="ip-board"/>
            <property name="port-to-query" value="port-board"/>
            <property name="relay-number" value="8"/>
            <property name="analog-input-number" value="2"/>
            <property name="digital-input-number" value="4"/>
            <property name="starting-relay" value="0"/>
            <property name="led-tag" value="led"/>
            <property name="analog-input-tag" value="analog"/>
            <property name="digital-input-tag" value="btn"/>
        </tuple>
    </tuples>
</config>
ParameterRequiredValuesEffectNote
address-delimiteryes: or something elsedelimiter for address components 
change-state-relay-urlyesleds.cgi?led=integrated webserver url for relay changing state 
send-pulse-relay-urlyesrlyfs.cgi?rlyf=integrated webserver url for relay sending pulse 
get-status-urlyesstatus.xmlintegrated webserver url for retrieving state 

For each connected board the parameters are the following

ParameterRequiredValuesEffectNote
aliasyesstringidentifies the boardused in the object address
ip-to-queryyesip-addressset the board ip address 
port-to-queryyes set the port number 
relay-numberyes number of relays 
analog-input-numberyes number of analog inputs 
digital-input-numberyes number of digital inputs 
starting-relayyes0 or 1starting number in status.xml 
led-tagyes"led"status.xml tagfor compatibility with previous versions
analog-input-tagyes"analog" or "an"status.xml tagfor compatibility with previous versions
digital-input-tagyes"btn"status.xml tagfor compatibility with previous versions

 

How to control an object with this board

With this board you can control the powered behavior of any electric device in your environment, meaning you can turn on/off electric devices.

For this example we use a light object:

  1. Open the file ipx800.xml into freedomotic/plugins/devices/ipx800 folder and set ip-address and port number of your  board
  2. Right click on the light object in the environment to show its configuration panel
  3. Change the property "protocol" to "ipx800"
  4. Change the property "address" to a string composed of ALIAS:RELAY_NUMBER:led  where ALIAS is the string used to identify the board, RELAY_NUMBER is the relay on which your object is connected (from 1 to 8 the maximum number of supported  relays) and led is used to retrieve the relay state from status.xml file.  An example address can be "default:1:led" this identifies the first relay on a board listening on port 80 of the http URL 192.168.201.10
  5. Under "turn on" (in Actions) select the command called "Turn on Relay on Ipx800 board"
  6. Under "turn off" (in Actions) select the command called "Turn off Relay on Ipx800 board"

 The plugin is able to read any relay status change and update the object one.

  1. Under "powered" (in Data Sources) select the command called "IPX800 board reads a state change"

 

How to control an object with this board

Hosted here.

For French users

Visit http://www.domotique-info.fr/2012/08/freedomotic-support-de-la-carte-ipx...

Open Source Internet of Things Framework Drupal theme by Kiwi Themes.