jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Update ADS documentation (#4145)

Browse source
This commit is contained in:
Fabian Affolter 2017-12-06 08:10:25 +01:00 • committed by GitHub
parent 39bed44f77
commit 93f964b786
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 54 additions and 73 deletions
Download patch file Download diff file Expand all files Collapse all files

56
source/_components/ads.markdown
View file

@ -7,33 +7,15 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
logo: beckhoff.png
ha_category: Hub
ha_release: 0.60
ha_release: "0.60"
ha_iot_class: "Local Push"
---
The ADS (automation device specification) describes a device-independent and
fieldbus-independent interface for communication between Beckhoff® automation
devices running TwinCAT® and other devices implementing this interface.
Configuration parameters:
{% configuration %}
device:
required: true
description: The AMS NetId that identifies the device
type: string
port:
required: true
description: The port that runs the AMS server on the device, typically this would be 801 or 851
type: integer
ip_address:
required: false
description: The IP-Address of the ADS device, if not set the first 4 bytes of the device id will be used
type: string
{% endconfiguration %}
The ADS (automation device specification) describes a device-independent and fieldbus independent interface for communication between [Beckhoff](https://www.beckhoff.com/) automation devices running [TwinCAT](http://www.beckhoff.hu/english.asp?twincat/default.htm) and other devices implementing this interface.
To enable ADS, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -42,10 +24,24 @@ ads:
port: 48898
```
## Service
{% configuration %}
device:
required: true
description: The AMS NetId that identifies the device.
type: string
port:
required: true
description: The port that runs the AMS server on the device, typically this would be 801 or 851.
type: int
ip_address:
required: false
description: The IP address of the ADS device, if not set the first 4 bytes of the device id will be used.
type: string
{% endconfiguration %}
The ADS component will register the service `write_by_name` allowing you to
write a value to a variable on your ADS device.
## {% linkable_title Service %}
The ADS component will register the service `write_by_name` allowing you to write a value to a variable on your ADS device.
```json
{
@ -57,9 +53,7 @@ write a value to a variable on your ADS device.
Service parameters:
- **adsvar**: name of the variable on the ADS device. To access global variables
on *TwinCAT2* use a prepending dot `.myvariable`, for TwinCAT3 use
`GBL.myvariable`
- **adstype**: specify the type of the variable. Use one of the following:
`int`, `byte`, `uint`, `bool`
- **value**: the value that will be written in the variable
- **adsvar**: Name of the variable on the ADS device. To access global variables on *TwinCAT2* use a prepending dot `.myvariable`, for TwinCAT3 use
`GBL.myvariable`.
- **adstype**: Specify the type of the variable. Use one of the following: `int`, `byte`, `uint`, `bool`
- **value**: The value that will be written in the variable.