E3DC Remote Storage Control Protocol (RSCP)

torben78 · March 7, 2024, 6:05pm

Attention: If your E3DC gets updated to firmware P10_2023_06, you will quite probably run into exceptions regarding missing RSCP tags, which effectively breaks the integration. So far as we can tell right now, E3DC changed the API silently, it does no longer match the published information.

As an immediate workaround, I have published 3.6.1-beta.1, which should disable the corresponding code path in the E3DC integration. I’m currently testing this with a few users to validate the workaround. In the meantime I’m in contact with fsanti, the owner of the underlying pye3dc library to find a permanent solution.

More information and the current state of affairs can be found at the issue trackers:

github.com/torbennehmer/hacs-e3dc

16777278 is not a valid RscpTag

opened 06:02AM - 01 Mar 24 UTC

kobelka

bug

### System Health details ## System Information version | core-2024.2.5 -- …| -- installation_type | Home Assistant OS dev | false hassio | true docker | true user | root virtualenv | false python_version | 3.12.1 os_name | Linux os_version | 6.6.16-haos arch | x86_64 timezone | Europe/Berlin config_dir | /config <details><summary>Home Assistant Community Store</summary> GitHub API | ok -- | -- GitHub Content | ok GitHub Web | ok GitHub API Calls Remaining | 4996 Installed Version | 1.34.0 Stage | running Available Repositories | 1401 Downloaded Repositories | 41 </details> <details><summary>Home Assistant Cloud</summary> logged_in | false -- | -- can_reach_cert_server | ok can_reach_cloud_auth | ok can_reach_cloud | ok </details> <details><summary>Home Assistant Supervisor</summary> host_os | Home Assistant OS 12.0 -- | -- update_channel | stable supervisor_version | supervisor-2024.02.1 agent_version | 1.6.0 docker_version | 24.0.7 disk_total | 491.4 GB disk_used | 118.7 GB healthy | true supported | true board | ova supervisor_api | ok version_api | ok installed_addons | Node-RED (17.0.7), FTP (5.0.1), InfluxDB (5.0.0), MariaDB (2.6.1), Studio Code Server (5.15.0), Z-Wave JS UI (3.4.0), Mosquitto broker (6.4.0), ha-sip (3.5.1), Home Assistant Google Drive Backup (0.112.1), Zigbee2MQTT (1.35.3-1), Music Assistant BETA (2.0.0b106), Cloudflared (5.1.4) </details> <details><summary>Dashboards</summary> dashboards | 3 -- | -- resources | 23 views | 59 mode | storage </details> <details><summary>Recorder</summary> oldest_recorder_run | 31. Januar 2024 um 15:35 -- | -- current_recorder_run | 29. Februar 2024 um 18:01 estimated_db_size | 40742.48 MiB database_engine | mysql database_version | 10.6.12 </details> ### Checklist - [X] I have enabled debug logging for my installation. - [X] I have filled out the issue template to the best of my ability. - [X] This issue only contains 1 issue (if you have multiple issues, open one issue for each issue). - [X] This issue is not a duplicate issue of currently [previous issues](https://github.com/torbennehmer/hacs-e3dc/issues?q=is%3Aissue+label%3A%22Bug%22+).. ### Describe the issue The addon work for a long time, but now I can´t get it connected again. I restarted the e3dc, home assistant and reinstalled the addon allready. I double checked the password etc. ### Reproduction steps no connection to the e3dc ### Debug logs ```text Dieser Fehler wurde von einer benutzerdefinierten Integration verursacht Logger: custom_components.e3dc_rscp.e3dc_proxy Source: custom_components/e3dc_rscp/e3dc_proxy.py:29 Integration: E3DC Remote Storage Control Protocol (Git) (documentation, issues) First occurred: 29. Februar 2024 um 18:01:51 (608 occurrences) Last logged: 07:01:13 Communication error with E3DC: Max retries reached Traceback (most recent call last): File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc_rscp_local.py", line 102, in sendRequest receive = self._receive() ^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc_rscp_local.py", line 76, in _receive decData = rscpDecode(self.encdec.decrypt(data))[0] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_rscpLib.py", line 263, in rscpDecode return rscpDecode(rscpFrameDecode(data)[0]) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_rscpLib.py", line 279, in rscpDecode innerData, usedLength = rscpDecode(data[curByte:]) ^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_rscpLib.py", line 270, in rscpDecode strTag = getStrRscpTag(hexTag) ^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_rscpTags.py", line 3692, in getStrRscpTag tag = RscpTag(tag) ^^^^^^^^^^^^ File "/usr/local/lib/python3.12/enum.py", line 744, in __call__ return cls.__new__(cls, value) ^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/enum.py", line 1158, in __new__ raise ve_exc ValueError: 16777278 is not a valid RscpTag During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc.py", line 226, in sendRequest result = self.rscp.sendRequest(request) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc_rscp_local.py", line 108, in sendRequest raise CommunicationError e3dc._e3dc_rscp_local.CommunicationError During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/config/custom_components/e3dc_rscp/e3dc_proxy.py", line 29, in wrapper_handle_e3dc_ex return func(*args, **kwargs) ^^^^^^^^^^^^^^^^^^^^^ File "/config/custom_components/e3dc_rscp/e3dc_proxy.py", line 121, in get_manual_charge data = self.e3dc.sendRequest( ^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc.py", line 237, in sendRequest raise SendError("Max retries reached") e3dc._e3dc.SendError: Max retries reached Dieser Fehler wurde von einer benutzerdefinierten Integration verursacht Logger: custom_components.e3dc_rscp.coordinator Source: helpers/update_coordinator.py:313 Integration: E3DC Remote Storage Control Protocol (Git) (documentation, issues) First occurred: 29. Februar 2024 um 18:01:51 (608 occurrences) Last logged: 07:01:13 Unexpected error fetching e3dc_rscp data: Communication Failure: Failed to send data Traceback (most recent call last): File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc_rscp_local.py", line 102, in sendRequest receive = self._receive() ^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc_rscp_local.py", line 76, in _receive decData = rscpDecode(self.encdec.decrypt(data))[0] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_rscpLib.py", line 263, in rscpDecode return rscpDecode(rscpFrameDecode(data)[0]) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_rscpLib.py", line 279, in rscpDecode innerData, usedLength = rscpDecode(data[curByte:]) ^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_rscpLib.py", line 270, in rscpDecode strTag = getStrRscpTag(hexTag) ^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_rscpTags.py", line 3692, in getStrRscpTag tag = RscpTag(tag) ^^^^^^^^^^^^ File "/usr/local/lib/python3.12/enum.py", line 744, in __call__ return cls.__new__(cls, value) ^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/enum.py", line 1158, in __new__ raise ve_exc ValueError: 16777278 is not a valid RscpTag During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc.py", line 226, in sendRequest result = self.rscp.sendRequest(request) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc_rscp_local.py", line 108, in sendRequest raise CommunicationError e3dc._e3dc_rscp_local.CommunicationError During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/config/custom_components/e3dc_rscp/e3dc_proxy.py", line 29, in wrapper_handle_e3dc_ex return func(*args, **kwargs) ^^^^^^^^^^^^^^^^^^^^^ File "/config/custom_components/e3dc_rscp/e3dc_proxy.py", line 121, in get_manual_charge data = self.e3dc.sendRequest( ^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc.py", line 237, in sendRequest raise SendError("Max retries reached") e3dc._e3dc.SendError: Max retries reached The above exception was the direct cause of the following exception: Traceback (most recent call last): File "/usr/src/homeassistant/homeassistant/helpers/update_coordinator.py", line 313, in _async_refresh self.data = await self._async_update_data() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/config/custom_components/e3dc_rscp/coordinator.py", line 157, in _async_update_data data = await self.hass.async_add_executor_job(self.proxy.get_manual_charge) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/concurrent/futures/thread.py", line 58, in run result = self.fn(*self.args, **self.kwargs) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/config/custom_components/e3dc_rscp/e3dc_proxy.py", line 37, in wrapper_handle_e3dc_ex raise HomeAssistantError( homeassistant.exceptions.HomeAssistantError: Communication Failure: Failed to send data ``` ### Diagnostics dump _No response_

and

github.com/fsantini/python-e3dc

Unknown tag 0x100003E in response to EMS_REQ_GET_MANUAL_CHARGE

opened 05:20PM - 05 Mar 24 UTC

torbennehmer

Hi @fsantini, with the most recent firmware upgrade of the E3DCs, the API for… EMS_REQ_GET_MANUAL_CHARGE seems to have changed. Seen in - https://github.com/torbennehmer/hacs-e3dc/issues/114 - https://github.com/rxhan/RSCPGui/issues/47 In my case this is triggered by this code snippet: ```python e3dc.sendRequest((RscpTag.EMS_REQ_GET_MANUAL_CHARGE, RscpType.NoneType, None), keepAlive=True) ``` Resulting in this Stacktrace: ``` File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc_rscp_local.py", line 102, in sendRequest receive = self._receive() ^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc_rscp_local.py", line 76, in _receive decData = rscpDecode(self.encdec.decrypt(data))[0] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_rscpLib.py", line 263, in rscpDecode return rscpDecode(rscpFrameDecode(data)[0]) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_rscpLib.py", line 279, in rscpDecode innerData, usedLength = rscpDecode(data[curByte:]) ^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_rscpLib.py", line 270, in rscpDecode strTag = getStrRscpTag(hexTag) ^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_rscpTags.py", line 3692, in getStrRscpTag tag = RscpTag(tag) ^^^^^^^^^^^^ File "/usr/local/lib/python3.12/enum.py", line 744, in __call__ return cls.__new__(cls, value) ^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/enum.py", line 1158, in __new__ raise ve_exc ValueError: 16777278 is not a valid RscpTag During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc.py", line 226, in sendRequest result = self.rscp.sendRequest(request) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/usr/local/lib/python3.12/site-packages/e3dc/_e3dc_rscp_local.py", line 108, in sendRequest raise CommunicationError e3dc._e3dc_rscp_local.CommunicationError ``` The workaround of @kobelka in #108 will hide the problem, however it doesn't really solve it. I can't reverse engineer that at the moment as my E3DC is still using the old firmware. I'm not sure, what the best approach would be at the moment for pye3dc. For HACS-E3DC, i'll disable the piece of code for the moment as a hotfix, as its around manual charging, we'll probably can live with that for the moment.

Please stay patient, we’re working on this.

Torben