Skip to content

Commit

Permalink
removed *.conf examples and reference from Readme.md A-E
Browse files Browse the repository at this point in the history
  • Loading branch information
bmxp committed Mar 31, 2018
1 parent 062fdc2 commit a8516a2
Show file tree
Hide file tree
Showing 28 changed files with 704 additions and 2,114 deletions.
37 changes: 2 additions & 35 deletions apcups/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Should work on all APC UPS devices. Tested only on a "smartUPS".

## Configuration

### plugin.conf
### plugin.yaml

Add the following lines to activate the plugin:

Expand All @@ -31,24 +31,13 @@ ApcUps:
port: 3551
```
or the same for deprecated *.conf file format:
```ini
[apcups]
class_name = APCUPS
class_path = plugins.apcups
# host = localhost
# port = 3551
# cycle = 300
```

Description of the attributes:
* __host__: ip address of the NIS (optional, default: localhost)
* __port__: port of the NIS (optional, default: 3551)
* __cycle__: time to update the items with values from apcaccess
### items.conf
### items.yaml
There is only one attribute: **apcups**
Expand Down Expand Up @@ -138,28 +127,6 @@ serverroom:
apcups: timeleft
```
or in (deprecated) *.conf format:
```ini
# items/apcups.conf
[serverroom]
[[apcups]]
[[[linev]]]
visu_acl = ro
type = num
apcups = linev

[[[status]]]
# will be 'ONLINE', 'ONBATT', or in case of a problem simply empty
visu_acl = ro
type = str
apcups = status

[[[timeleft]]]
visu_acl = ro
type = num
apcups = timeleft
```
**type** depends on the values.
### Status Report Fields
Expand Down
26 changes: 7 additions & 19 deletions artnet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,11 @@ OLA supports most USB -> DMX Adapters available at the moment.

## Supported Hardware

* Hardware supported by OLA. See Link above.
* Hardware supported by OLA. See Link above.

## Configuration

### plugin.conf (deprecated) / .yaml

```
[dmx1]
class_name = ArtNet
class_path = plugins.artnet
artnet_subnet = 0
artnet_net = 0
artnet_universe = 0
ip = 192.168.1.123
port = 6454
```
### plugin.yaml

```
dmx1:
Expand All @@ -36,14 +25,14 @@ dmx1:
port: 6454
```

### items.conf
### items.yaml

Not needed yet.

### logic.conf
### logic.yaml
Notice: First DMX channel is 1! Not 0!

To send DMX Data to the universe set in plugin.conf you have 3 possibilities:
To send DMX Data to the universe set in plugin.yaml you have 3 possibilities:

#### 1) Send single value
``sh.dmx1(<DMX_CHAN>, <DMX_VALUE>)``
Expand All @@ -52,7 +41,7 @@ Sets DMX_CHAN to value DMX_VALUE.

Example: ``sh.dmx1(12,255)``
If channels 1-11 are already set, they will not change.
If channels 1-11 are not set till now, the will be set to value 0.
If channels 1-11 are not set till now, the will be set to value 0.
This is needed because on a DMX bus you can not set just one specific channel.
You have to begin at first channel setting your values.

Expand All @@ -63,7 +52,7 @@ Sends <DMX_VALUE_LIST> to DMX Bus starting at <DMX_CHAN>
Example:
``sh.dmx1(10,[0,33,44,55,99])``
If channels 1-9 are already set, they will not change.
If channels 1-9 are not set till now, the will be set to value 0.
If channels 1-9 are not set till now, the will be set to value 0.
This is needed because on a DMX bus you can not set just one specific channel.
You have to begin at first channel setting your values.
Values in square brackets will be written to channel (10-14)
Expand All @@ -80,4 +69,3 @@ Example:

``sh.dmx1([0,33,44,55,99])``
Values in Square brackets will be written to channel (1-5)

65 changes: 35 additions & 30 deletions asterisk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,28 @@ In manager.config its required to enable at least:

## Configuration

### plugin.conf
### plugin.yaml

The plugin needs the username and password of the AMI and a IP and port address if asterisk does not run on localhost.
The plugin needs the username and password of the AMI and a IP and port address if asterisk does not run on localhost.

```yaml
ast:
class_name: Asterisk
class_path: plugins.asterisk
username: admin
password: secret
host: 127.0.0.1 # default
port: 5038 # default

```
[ast]
class_name = Asterisk
class_path = plugins.asterisk
username = admin
password = secret
host = 127.0.0.1 # default
port = 5038 # default
```

### items.conf
### items.yaml

#### ast_dev

Its possible to specify the ``ast_dev`` attribute to an bool item in items.conf. The argument could be a number or string and corrospond to thhe asterisk device configuration.
E.g. ``2222`` for the following device in asterisk sip.conf:
It is possible to specify the ``ast_dev`` attribute to an bool item in items.yaml.
The argument could be a number or string and correspond to the asterisk device configuration.
E.g. ``2222`` for the following device in asterisk ``sip.conf``:

```
[2222]
Expand All @@ -41,32 +43,35 @@ The mailbox number of this phone. It will be set to the number of new messages i
#### ast_db
Specify the database entry which will be updated at an item change.

In items.conf:
In items.yaml:

```
[office]
[[fon]]
type = bool
ast_dev = 2222
ast_db = active/office
[[[box]]]
type = num
ast_box = 22
```yaml
office:

fon:
type: bool
ast_dev: 2222
ast_db: active/office

box:
type: num
ast_box: 22
```
Calling the '2222' from sip client or making a call from it, ``office.fon`` will be set to True. After finishing the call, it will be set to False.
Calling the '2222' from sip client or making a call from it, item ``office.fon`` will be set to True.
After finishing the call, it will be set to False.
### logic.conf
### logic.yaml
It is possible to specify the `ast_userevent` keyword to every logic in logic.conf.
It is possible to specify the `ast_userevent` keyword to every logic in logic.yaml.

```
[logic1]
ast_userevent = Call
logic1:
ast_userevent: Call

[logic2]
ast_userevent = Action
logic2:
ast_userevent: Action
```
In the asterisk extensions.conf ``exten => _X.,n,UserEvent(Call,Source: ${CALLERID(num)},Value: ${CALLERID(name)})`` would trigger 'logic1' every time, this UserEvent is sent.
Expand Down
Loading

0 comments on commit a8516a2

Please sign in to comment.