Modbus: raw

[nikito7]

We can use raw to send all hex response

And split with templates on home assistant

AA,BB,CC,...

[nikito7]

text_sensor do that
But with comma will be cool

Easy to split with templates

@martgras

  - platform: template
    sensors:

      rtu1_vol_l1:
        friendly_name: "RTU1 Voltage L1"
        value_template: >-
          {{ states('sensor.rtu1_x108').split(',')[0] | int / 10 }}
        unit_of_measurement: "V"

      rtu1_cur_l1:
        friendly_name: "RTU1 Current L1"
        value_template: >-
          {{ states('sensor.rtu1_x108').split(',')[1] | int / 10 }}
        unit_of_measurement: "A"

Just an example of another component
Yours only needs this for text sensors

[nikito7]

I only need this for clock

12 bytes

I dont want to use lambda, its ugly

Thanks

  commas: true/false

[martgras]

Good idea. Instead of adding another options I changed hex_encode to raw_encode

• raw_encode: (NONE, HEXBYTES, COMMA) If the response is binary data it can't be published. Since a text sensor only publishes strings the binary data can encoded
  • HEXBYTES : 2 byte hex string. 0x2011 will be sent as "2011".
  • COMMA : Byte values as integers, delimited by a comma 0x2011 will be sent as "32,17"

 text_sensors:
      - name: "rtc_clock"
        id: rtc_clock
        internal: true
        modbus_functioncode: read_holding_registers
        address: 0x9013
        address: 0
        register_count: 3
        raw_encode: COMMA
        response_size: 6

[nikito7]

Not found raw_encode

What branch?

[nikito7]

None I think 🤣

[martgras]

forgot to push the changes :)
Just updated

[nikito7]

@martgras hex to decimal?

Ascii not possible without lambda?

[martgras]

Sorry I don't really understand your question.
If your modbus slave already returns a string than you don't need encode it at all.
raw_encode: NONE is the default setting

Maybe I misunderstand what you are asking for. Do have an example of the data you get from the slave?

[nikito7]

I just do hex to ascii (online converter)

And have text

[nikito7]

Working

😀

[nikito7]

@martgras run tools

black esphome/components/modbus_controller/

flake8 esphome/components/modbus_controller/

script/clang-format
esphome/components/modbus_controller/

script/clang-tidy esphome/components/modbus_controller/

script/ci-suggest-changes

[nikito7]

If you install pip3 install -r requeriment_tests.txt or all i dont remember

Everytime you try commit it run tools first

[martgras]

I have them installed and couldn't do a local commit for some issues. Well I hope I fixed the issues now.
Also ran the CODEOWNERS script.
... will need to look at my setup again since something seems to be broken with the tools on my box

[nikito7]

The easy way is virtualenv

esphome root dir
virtualenv venv
source venv/bin/activate
pip install -r ....txt

source venv/bin/activate
have to run every new shell

[nikito7]

run script/test

[martgras]

are you sure you are looking at the latest code.
I created a new branch for the PR (modbus_controller not modbus_component)
I don't see hex_encode in test4.yaml anymore and also CODEOWNERS seems have my name in it

For me esphome tests/test4.yaml compile runs without errors

[nikito7]

Waiting for some mantainer to review

I'm a basic user

[nikito7]

Maybe on_value for tariff?

if 1 "A"
If 2 "B"
If 3 "C"

[nikito7]

Only rtc_clock is ugly 😅

[nikito7]

I have done a polling on/off

[martgras]

did you implement it to avoid the too many message error ?

Any idea why I'm getting this error

script\ci-custom.py
************* File esphome/components/modbus_controller/examples/epever.yaml
ERROR esphome/components/modbus_controller/examples/epever.yaml:41:68 - File contains tab character. Please convert tabs to spaces.
ERROR esphome/components/modbus_controller/examples/epever.yaml:42:62 - File contains tab character. Please convert tabs to spaces.
ERROR esphome/components/modbus_controller/examples/epever.yaml:43:57 - File contains tab character. Please convert tabs to spaces.

There are no tab in the file

[nikito7]

did you implement it to avoid the too many message error ?

Advanced stuff. Like stop polling in wifi off or other. Debug

[martgras]

btw: found the tabs :)

[nikito7]

About generic function codes?

Or a full raw command request.

I have two special functions:

• 0145030000000101

• 0145xx0000yyyy01
  A specific line from netmetering history

• 01440601

• 0144xxyy
  Last netmetering profile

Maybe text sensor?
This return one response with different data types

[martgras]

Probably text sensor like in my rtc clock example.
So you have to send these commands and parse the respone?
I have to check my code tomorrow how to do it 🙂

[martgras]

ok - heavy lambda stuff but works for me
of course replace id(epever) with the name of your modbus_controller

  - platform: template
    id: custom_modbus_cmd
    name: "Template Text Sensor"
    lambda: |-
      esphome::modbus_controller::ModbusController *controller = id(epever);
      // create the payload
      std::vector<uint8_t> payload; 
      // create the payload by pushing all required bytes
      // example command send 0x9013 to device address 1 and read 3 holding registers
     // raw command 01.03.90.13.0.03
      payload.push_back(0x1) ;   // device address
      payload.push_back(0x03);   // Read holding
      payload.push_back(0x90);   // Register adddress high byte
      payload.push_back(0x13);   // Register adddress low byte
      payload.push_back(0);      // Number of registers high byte
      payload.push_back(0x3);   // Number of registers low byte
      // CRC will be added automatically 

      // this is the handler that will receive the response 
      auto on_response = [](esphome::modbus_controller::ModbusRegisterType, uint16_t, const std::vector<uint8_t> &data) {
        // parse data   - usually byte 3 contains the length of the response
        char first = data[0];
        // .. add your parsing code
        // convert the result to a string
        std::string result = "something";
        // publish the parsed code
        id(custom_modbus_cmd).publish_state(result);
      };
      // Create the custom_command 
      esphome::modbus_controller::ModbusCommandItem custom_command =
                esphome::modbus_controller::ModbusCommandItem::create_custom_command(controller,payload,on_response);
      // Submit the command to the send queue
      epever->queue_command(custom_command);

      ESP_LOGI("ModbusLambda", "Custom command send");
      // don't return a new state from here - wait for on_response getting called 
      // and publish from there
      return {};

[nikito7]

Not tried yet custom command.

But have done clock :-)

This just works without on_value.
I dont had seen any side effects

  - platform: modbus_controller
    name: "${dev} Clock"
    register_type: read
    address: 0x0001
    register_count: 1
    raw_encode: HEXBYTES
    response_size: 12
    icon: mdi:clock
    lambda: |-
        uint8_t hh=0,mm=0,ss=0;
        hh = esphome::modbus_controller::byte_from_hex_str(x,5);
        mm = esphome::modbus_controller::byte_from_hex_str(x,6);
        ss = esphome::modbus_controller::byte_from_hex_str(x,7);
        char buffer[20];
        sprintf(buffer,"%02d:%02d:%02d",hh,mm,ss);
        return {buffer};