From dec1db61350552ac812f0767c8b172633c94ff69 Mon Sep 17 00:00:00 2001
From: Pavel S <info@pavelslama.cz>
Date: Tue, 16 Jan 2024 18:20:38 +0100
Subject: [PATCH] chore: update readme

---
 README.md |  6 +++-
 info.md   | 97 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 102 insertions(+), 1 deletion(-)
 create mode 100644 info.md

diff --git a/README.md b/README.md
index 9963299..f91cdaf 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 [![validate](https://github.com/pilotak/homeassistant-mcp2221/actions/workflows/validate.yaml/badge.svg)](https://github.com/pilotak/homeassistant-mcp2221/actions/workflows/validate.yaml)
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
 
-The advantage of running HomeAssistant on Raspberry Pi is that you have a few GPIOs to play with. This integration adds missing GPIOs (input, output, ADC) to your NUC like / Proxmox based instalation.
+Integration that adds missing GPIOs (input, output, ADC) to your NUC or Proxmox-based installation over USB.
 
 ```yaml
 # Example configuration.yaml entry
@@ -36,6 +36,8 @@ mcp2221:
 
 You can find this integration in the community store.
 
+[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=pilotak&repository=homeassistant-mcp2221&category=Integration)
+
 ## Install manually
 
 You need to copy the `mcp2221` folder from this repo to the `custom_components` folder in the root of your configuration. The file tree should look like this:
@@ -75,6 +77,7 @@ mcp2221:
         unique_id: output_1_0
         icon: mdi:toggle-switch
 ```
+
 </details>
 
 <details>
@@ -92,6 +95,7 @@ mcp2221:
       scan_interval: 10
       device_class: door
 ```
+
 </details>
 
 <details>
diff --git a/info.md b/info.md
new file mode 100644
index 0000000..45e074c
--- /dev/null
+++ b/info.md
@@ -0,0 +1,97 @@
+# HomeAssistant - MCP2221 integration
+
+Integration that adds missing GPIOs (input, output, ADC) to your NUC or Proxmox-based installation over USB.
+
+```yaml
+# Example configuration.yaml entry
+mcp2221:
+  - switches:
+      - name: "Output 0"
+        pin: 0
+        unique_id: out0
+      - name: "Output 1"
+        pin: 1
+        unique_id: out1
+    binary_sensors:
+      - name: "Input 2"
+        pin: 2
+        unique_id: in2
+        device_class: door
+      - name: "Input 3"
+        pin: 3
+        unique_id: in3
+        icon: mdi:electric-switch
+    # adc:
+    #   ref: 4.096
+    #   sensors:
+    #     - name: "voltage"
+    #       pin: 3
+    #       unique_id: adc3
+```
+
+### Full examples
+
+<details>
+<summary>1️⃣Switch (output) & multiple devices</summary>
+You can also specift multiple device, just adjust the index (`dev`) or even specify different PID/VID
+
+```yaml
+mcp2221:
+  - dev: 0
+    pid: 0x00DD
+    vid: 0x04D8
+    switches:
+      - name: "Output 0"
+        pin: 0
+        unique_id: output_0_0
+        icon: mdi:toggle-switch
+  - dev: 1
+    switches:
+      - name: "Output 0"
+        pin: 0
+        unique_id: output_1_0
+        icon: mdi:toggle-switch
+```
+
+</details>
+
+<details>
+<summary>2️⃣Binary sensor (input)</summary>
+❗Don't leave pin floating
+
+```yaml
+mcp2221:
+  binary_sensors:
+    - name: "Input 1"
+      pin: 1
+      inverted: True
+      unique_id: input_0
+      icon: mdi:toggle-switch
+      scan_interval: 10
+      device_class: door
+```
+
+</details>
+
+<details>
+<summary>3️⃣Sensor (ADC)</summary>
+Only pins GP1-GP3, result is 10-bit (0-1023)
+
+You can also adjust the result, example here is when power supply is 3.3V
+
+```yaml
+mcp2221:
+  adc:
+    ref: "VDD" # or 1.024, 2.048, 4.096
+    sensors:
+      - name: "Battery voltage"
+        pin: 3
+        unique_id: battery_voltage
+        scan_interval: 50
+        icon: mdi:car-battery
+        device_class: voltage
+        unit_of_measurement: V
+        value_template: "{{ value * 3.3 / 1023}}"
+```
+
+</details>