72 lines
3.2 KiB
Markdown
72 lines
3.2 KiB
Markdown
|
---
|
||
|
|
id: k8055
|
||
|
|
label: Velleman k8055 USB IO Board
|
||
|
title: Velleman k8055 USB IO Board - Bindings
|
||
|
|
type: binding
|
||
|
|
description: "This binding allows you to integrate a [Velleman k8055 USB IO Board](http://www.vellemanusa.com/products/view/?country=us&lang=enu&id=500349) with openHAB."
|
||
|
|
source: https://github.com/openhab/openhab1-addons/blob/master/bundles/binding/org.openhab.binding.k8055/README.md
|
||
|
|
since: 1x
|
||
|
|
install: manual
|
||
|
|
---
|
||
|
|
|
||
|
|
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
|
||
|
|
|
||
|
|
{% include base.html %}
|
||
|
|
|
||
|
|
# Velleman k8055 USB IO Board Binding
|
||
|
|
|
||
|
|
This binding allows you to integrate a [Velleman k8055 USB IO Board](http://www.vellemanusa.com/products/view/?country=us&lang=enu&id=500349) with openHAB.
|
||
|
|
|
||
|
|
## Prerequisites
|
||
|
|
|
||
|
|
This binding makes use of JNI calls to the native k8055 library and thus requires that the native library is available. The binding has been tested on Linux with the open-source [libk8055](http://libk8055.sourceforge.net/) library. In principle it should also work on Windows with the Velleman provided DLL as it has the same API, however this has not yet been tested.
|
||
|
|
|
||
|
|
For the binding to access the native library correctly, the following conditions must be met:
|
||
|
|
|
||
|
|
* The library must be installed somewhere in the library search path (in Linux, a system lib directory is fine; on Windows\system32 folder.
|
||
|
|
* The JVM being used to run openHAB must be the same 'bitness' as the library (i.e. 32bit/64bit). If using the Velleman provided Windows DLL, this means running on a 32bit JVM.
|
||
|
|
|
||
|
|
## Binding Configuration
|
||
|
|
|
||
|
|
This binding can be configured in the file `services/k8055.cfg`.
|
||
|
|
|
||
|
|
| Property | Default | Required | Description |
|
||
|
|
|----------|---------|:--------:|-------------|
|
||
|
|
| refresh | 1000 | No | how often the binding should read the state of the hardware inputs, in milliseconds |
|
||
|
|
| boardno | | Yes | which board openhab should connect to. This must be specified to enable the binding. Currently the binding only supports connecting to a single board. |
|
||
|
|
|
||
|
|
## Item Configuration
|
||
|
|
|
||
|
|
The syntax of the binding configuration strings accepted is the following:
|
||
|
|
|
||
|
|
```
|
||
|
|
k8055="<IO-type>:<IO-number>"
|
||
|
|
```
|
||
|
|
|
||
|
|
where:
|
||
|
|
|
||
|
|
* **IO-type** is one of:
|
||
|
|
* DIGITAL_IN - Supports _Contact_ Items
|
||
|
|
* DIGITAL_OUT - Supports _Switch_ Items
|
||
|
|
* ANALOG_IN - Supports _Number_ Items
|
||
|
|
* ANALOG_OUT - Supports _Dimmer_ Items
|
||
|
|
|
||
|
|
* **IO-number** is the number (1-8) of the particular IO channel to bind to.
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```
|
||
|
|
Switch Output1 "Digital Output 1" { k8055="DIGITAL_OUT:1"}
|
||
|
|
Switch Output2 "Digital Output 2" { k8055="DIGITAL_OUT:2"}
|
||
|
|
|
||
|
|
Dimmer K8055_ANOUT_1 "K8055 Analog Output 1" { k8055="ANALOG_OUT:1"}
|
||
|
|
Dimmer K8055_ANOUT_2 "K8055 Analog Output 2" { k8055="ANALOG_OUT:2"}
|
||
|
|
|
||
|
|
Number K8055_ANIN_1 "K8055 Analog Input 1" { k8055="ANALOG_IN:1" }
|
||
|
|
Number K8055_ANIN_2 "K8055 Analog Input 2" { k8055="ANALOG_IN:2" }
|
||
|
|
```
|
||
|
|
|
||
|
|
## Troubleshooting
|
||
|
|
|
||
|
|
On some Linux distribution, the user openhab is running as may not have permissions to access the USB ports by default. It is worth checking that the standalone command-line program (k8055) that comes with libk8055 works under the relevant Linux user before attempting to use the binding. (Particularly as the driver outputs little useful debugging information to the logs).
|