62 lines
2.3 KiB
Markdown
62 lines
2.3 KiB
Markdown
---
|
|
id: openwebif
|
|
label: OpenWebIf
|
|
title: OpenWebIf - Actions
|
|
type: action
|
|
description: "The OpenWebIf action allows you to send a message to enigma2-based Linux satellite receivers (Dreambox, VU+, Clarke-Tech, ...) with the installed OpenWebIf plugin."
|
|
source: https://github.com/openhab/openhab1-addons/blob/master/bundles/action/org.openhab.action.openwebif/README.md
|
|
since: 1x
|
|
install: manual
|
|
---
|
|
|
|
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
|
|
|
|
{% include base.html %}
|
|
|
|
# OpenWebIf Action
|
|
|
|
The OpenWebIf action allows you to send a message to enigma2-based Linux satellite receivers (Dreambox, VU+, Clarke-Tech, ...) with the installed OpenWebIf plugin.
|
|
|
|
## Configuration
|
|
|
|
Configure your satellite receivers in `services/openwebif.cfg`.
|
|
|
|
| Property | Default | Required | Description |
|
|
|----------------------------|---------|:--------:|------------------------|
|
|
| `receiver.<name>.host` | | | For example, `vusolo2` |
|
|
| `receiver.<name>.port` | | | For example, `81` |
|
|
| `receiver.<name>.user` | | | For example, `root` |
|
|
| `receiver.<name>.password` | | | |
|
|
| `receiver.<name>.https` | | | For example, `false` |
|
|
|
|
### Configuration Example
|
|
|
|
```java
|
|
receiver.main.host=vusolo2
|
|
receiver.main.port=81
|
|
receiver.main.user=root
|
|
receiver.main.password=xxxxx
|
|
receiver.main.https=false
|
|
```
|
|
|
|
## Action
|
|
|
|
Now you can send a message to the configured receiver:
|
|
|
|
- `sendOpenWebIfNotification(NAME, MESSAGE, TYPE, TIMEOUT)`
|
|
|
|
| Parameter | Meaning |
|
|
|-----------|------------------------------------------------------|
|
|
| NAME | The configured name of the satellite receiver |
|
|
| MESSAGE | The message to send to the receiver |
|
|
| TYPE | The message type (INFO, WARNING, ERROR) |
|
|
| TIMEOUT | How long the text will stay on the screen in seconds |
|
|
|
|
## Examples
|
|
|
|
```java
|
|
sendOpenWebIfNotification("main", "Hello World!\n\nThis is a message sent from openHab!", "WARNING", 10)
|
|
```
|
|
|
|
|