Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 2.4 KB

README.md

File metadata and controls

43 lines (24 loc) · 2.4 KB

spine-go

Build Status GoDoc Coverage Status Go report CodeFactor

Introduction

This library provides an implementation of SPINE 1.3 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.

Important: In contrast to the EEBUS recommendation to use a "Generic" client feature, this library does not support this for the local device! Instead one should create a feature type with the client role for every required feature.

Packages

api

This package contains required interfaces. They are used extensivly to be able to mock everything and implement tests that focus specificaly on a limited set of interface implementations

integrationtests

This packge contains tests that cover implementations of multiple packages in concert.

mocks

This package contains auto generated mocks for the interfaces defined in the api package using Mockery.

model

This package contains the go represenation of the SPINE data model. It makes use of go tags for proper JSON serialization and also for implementing generic SPINE feature to function and data mapping.

spine

This package contains the implementation for working with the SPINE devices, entites, features, functions and data.

util

This package contains generic helpers used by most of the packages, e.g. for working with pointers.