https://github.com/paveldn/haierprotocol

Haier communication protocol library
https://github.com/paveldn/haierprotocol

cpp esp-idf haier library protocol uart

Last synced: about 2 months ago
JSON representation

Haier communication protocol library

• Host: GitHub
• URL: https://github.com/paveldn/haierprotocol
• Owner: paveldn
• License: mit
• Created: 2022-12-03T06:50:44.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-20T09:35:51.000Z (5 months ago)
• Last Synced: 2024-08-21T11:43:33.278Z (4 months ago)
• Topics: cpp, esp-idf, haier, library, protocol, uart
• Language: C++
• Homepage:
• Size: 175 KB
• Stars: 13
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
HaierProtocol

=============

This library implements a Haier protocol transport level. It can help

with sending and receiving messages to appliances that support it and

process answers.

Protocol description

--------------------

Haier protocol is a synchronous protocol. All data delivered with this

protocol is split into portions - frames. The protocol has two versions.

One is used for older HVAC units that work with the SmartAir2

application. Another is for newer units that work with the hOn

application. Those version commands are different but the frame

structure and transport level of the protocol are the same.

Haier frame

-----------

.. list-table:: Frame structure

  * - **Frame separator**

    - **Frame length**

    - **Frame flags**

    - **Reserved space**

    - **Type**

    - **Frame data**

    - **Checksum**

    - **CRC**

  * - 2 bytes

    - 1 byte

    - 1 byte

    - 5 bytes

    - 1 byte

    - | n bytes

      | (n <= 246)

    - 1 byte

    - 2 bytes 

Where:

 * **Frame separator** - 2 bytes, have fixed value 0xFF 0xFF, used as a marker for the beginning of the frame

 * **Frame length** - 1 byte, number of bytes of the entire frame, includes frame flags, reserved space, type byte, frame data, and checksum, max value is 254 \*

 * **Frame flags** - 1 byte, only 2 values used 0x40 - indicates that frame have CRC bytes, 0x00 - indicates that there is no CRC

 * **Reserved space** - 5 bytes, reserved for future use, filled with 0x00

 * **Frame type** - 1 byte, type of frame (depend on the protocol)

 * **Frame data** - n byte, data of the frame, can be empty. Sometimes first 2 bytes of data are used as a subcommand. Max size 246

 * **Checksum** - 1 byte, the least significant byte of the sum of all bytes of the frame except separator bytes, CRC, and checksum itself.

 * **CRC** - 2 bytes, CRC 16 of all bytes of the frame except separator bytes, checksum byte, and CRC itself (`CRC-16/ARC `_ algorithm used). CRC is available only if the frame flags byte indicates it.