Skip to content

Commit 3e60b6f

Browse files
tomer-wCopilot
andcommitted
Update README with CAN adapter support and bump version to 2026.3.0
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent bd1d3b6 commit 3e60b6f

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@
66

77
> Transform your boat's NMEA 2000 network into powerful Home Assistant sensors instantly!
88
9-
A Home Assistant integration that brings marine data to your smart home. Automatically detect and convert NMEA 2000 messages into Home Assistant sensors with zero configuration. Works with both USB and TCP CAN bus gateways. Based on pure Python NMEA 2000 [package](https://pypi.org/project/nmea2000/) built over [canboat](https://github.com/canboat/canboat) database.
9+
A Home Assistant integration that brings marine data to your smart home. Automatically detect and convert NMEA 2000 messages into Home Assistant sensors with zero configuration. Works with USB, TCP, and python-can CAN bus gateways. Based on pure Python NMEA 2000 [package](https://pypi.org/project/nmea2000/) built over [canboat](https://github.com/canboat/canboat) database.
1010

1111
## ✨ Features
1212

1313
- **Plug & Play** - Automatic sensor creation from detected messages
1414
- **USB gateways**: CANBUS USB devices like [Waveshare USB-CAN-A](https://www.waveshare.com/wiki/USB-CAN-A)
15+
- **CAN adapter gateways**: Any generic USB or SocketCAN device supported by [python-can](https://python-can.readthedocs.io/) (e.g. Canable, Seeedstudio, SocketCAN on Linux/Raspberry Pi)
1516
- **TCP gateways**: CANBUS TCP devices like:
1617
- [EBYTE ECAN-W01S](https://www.cdebyte.com/products/ECAN-W01S)
1718
- [EBYTE ECAN-E01](https://www.cdebyte.com/products/ECAN-E01)
@@ -25,7 +26,7 @@ A Home Assistant integration that brings marine data to your smart home. Automat
2526

2627
### Prerequisites
2728
- A working Home Assistant installation
28-
- NMEA 2000 network with compatible gateway (USB or TCP)
29+
- NMEA 2000 network with compatible gateway (USB, CAN adapter, or TCP)
2930

3031

3132
### 🛠 Option 1: Installation via HACS
@@ -50,8 +51,8 @@ Restart Home Assistant when prompted.
5051
1. Go to Settings → Devices & Services → + Add Integration and search for NMEA 2000. Or, press the link below:
5152
[![Open your Home Assistant instance and show an integration.](https://my.home-assistant.io/badges/integration.svg)](https://my.home-assistant.io/redirect/integration/?domain=nmea2000)
5253
2. Click the **ADD HUB** button
53-
3. Choose a name and if the gateway is USB or TCP one.
54-
4. Based on the gateway type choose how to connect to it (USB port or TCP IP and port)
54+
3. Choose a name and select the gateway type: USB, TCP, or CAN.
55+
4. Based on the gateway type, configure connection parameters (USB port, TCP IP/port, or CAN interface/channel/bitrate)
5556
2. **Customize**: Choose what PGNs to monitor and in what cadance you want the updates
5657

5758
### 🛠 Script-Based Update (For Limited Bandwidth Environments)

custom_components/nmea2000/manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@
1313
"requirements": [
1414
"nmea2000==2026.3.0"
1515
],
16-
"version": "2025.10.3"
16+
"version": "2026.3.0"
1717
}

0 commit comments

Comments
 (0)