diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index c72e0b32..c600af34 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -8,7 +8,7 @@ body: id: description attributes: label: Description - description: A clear and concise description of what the bug is. Anything related to actual message definitions in [ebusd-configuration](https://github.com/john30/ebusd-configuration), serial bridge in [ebusd-esp](https://github.com/john30/ebusd-esp), or [eBUS adapter v3/v2](https://github.com/eBUS/adapter) do not belong here! Use the appropriate repository for those. + description: A clear and concise description of what the bug is. Anything related to actual message definitions in [ebusd-configuration](https://github.com/john30/ebusd-configuration), [eBUS Adapter Shield v5](https://github.com/john30/ebusd-esp32), serial bridge in [ebusd-esp](https://github.com/john30/ebusd-esp), or [eBUS adapter v3/v2](https://github.com/eBUS/adapter) do not belong here! Use the appropriate repository for those. placeholder: e.g. during startup, an error message as described below is reported instead of... validations: required: true @@ -97,19 +97,15 @@ body: label: Hardware interface description: the eBUS hardware interface in use options: - - adapter 5 via USB - - adapter 5 via WiFi - - adapter 5 via Ethernet - - adapter 5 via Raspberry GPIO - - adapter 3.1 USB - - adapter 3.1 WiFi - - adapter 3.1 Ethernet - - adapter 3.1 RPi - - adapter 3.0 USB - - adapter 3.0 WiFi - - adapter 3.0 Ethernet - - adapter 3.0 RPi - - adapter 2 + - Adapter Shield v5 via USB + - Adapter Shield v5 via WiFi + - Adapter Shield v5 via Ethernet + - Adapter Shield v5 via Raspberry GPIO + - Adapter v3 USB + - Adapter v3 WiFi + - Adapter v3 Ethernet + - Adapter v3 RPi + - Adapter v2 - other validations: required: true diff --git a/README.md b/README.md index 1a031119..7111f855 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ The main features of the daemon are: * TCP * UDP * enhanced ebusd protocol allowing arbitration to be done directly by the hardware, e.g. for recent - * [ebus adapter 5](https://adapter.ebusd.eu/v5/), or + * [eBUS Adapter Shield](https://adapter.ebusd.eu/v5/), or * [ebusd-esp firmware](https://github.com/john30/ebusd-esp/) * actively send messages to and receive answers from the eBUS * passively listen to messages sent on the eBUS @@ -35,6 +35,7 @@ The main features of the daemon are: * automatically check for updates of daemon and configuration files * pick preferred language for translatable message configuration parts * grab all messages on the eBUS and provide decoding hints + * send arbitrary messages from hex input or inject those * log messages and problems to a log file * capture messages or sent/received bytes to a log file as text * dump received bytes to binary files for later playback/analysis @@ -97,7 +98,7 @@ Docker image A multi-architecture Docker image using the config web service for retrieving the latest message configuration files is available on the hub. You can use it like this: > docker pull john30/ebusd -> docker run -it --rm --device=/dev/ttyUSB0 -p 8888 john30/ebusd +> docker run -it --rm --device=ens:/dev/ttyUSB0 -p 8888 john30/ebusd For more details, see [Docker Readme](https://github.com/john30/ebusd/blob/master/contrib/docker/README.md).