2024-11-27 18:57:16 +01:00

73 lines
2.0 KiB
Markdown

---
title: Pencom
description: How to use Pencom Designs 8 channel relay boards.
ha_category:
- Switch
ha_release: 0.85
ha_iot_class: Local Polling
ha_domain: pencom
ha_platforms:
- switch
ha_integration_type: integration
related:
- docs: /docs/configuration/
title: Configuration file
ha_quality_scale: legacy
---
[Pencom Design](https://www.pencomdesign.com/) is a manufacturer of computer-controlled relay, I/O and custom boards for commercial and industrial applications. This interface to [Pencom's Relay Control Boards](https://www.pencomdesign.com/relay-boards) is designed to work over an ethernet to serial adapter (NPort). Each switch (relay) can be turned on/off, and the state of the relay can be read.
## Configuration
The Pencom relays can be daisy-chained to allow for up to 8 boards. To enable Pencom in your installation, add it to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
``` yaml
# Example configuration.yaml entry
switch:
- platform: pencom
host: host.domain.com
port: 4001
boards: 2
relays:
- name: "Irrigation"
addr: 0
- name: "Upper Entry Door"
addr: 1
- name: "Fountain"
addr: 0
board: 2
```
{% configuration %}
host:
description: The IP address of the ethernet to serial adapter. It is assumed that the adapter has been preconfigured.
required: true
type: string
port:
description: The port of the ethernet to serial adapter.
required: true
type: integer
boards:
description: Number of boards daisy-chained together (default is 1).
required: false
type: integer
relays:
description: List of relays.
required: true
type: list
keys:
name:
description: The name of the switch (component).
required: true
type: string
addr:
description: The relay on the board starting with 0.
required: true
type: integer
board:
description: The board number (defaults to 1).
required: false
type: integer
{% endconfiguration %}