enbility / ship-go

EEBUS SHIP protocol implementation in go

ship-go

This library provides an implementation of SHIP 1.0.1 in go, which is part of the EEBUS specification.

Basic understanding of the EEBUS concepts SHIP and SPINE to use this library is required. Please check the corresponding specifications on the EEBUS downloads website.

This repository was started as part of the eebus-go before it was moved into its own repository and this separate go package.

Overview

Includes:

• Certificate handling
• mDNS, incl. avahi support (recommended)
• Websocket server and client
• Connection handling, including reconnection and double connections
• Handling of device pairing
• SHIP handshake
• Logging which is also used by spine-go and eebus-go

Implementation notes

• Double connection handling is not implemented according to SHIP 12.2.2. Instead the connection initiated by the higher SKI will be kept. Much simpler and always works
• PIN Verification is NOT supported other than SHIP 13.4.4.3.5.1 "none" PIN state is supported!
• Access Methods SHIP 13.4.6 only supports the most basic scenario and only works after PIN verification state is completed.
• Supported registration mechanisms (SHIP 5):
  • auto accept (without any interaction mechanism!)
  • user verification