zda

README

Shimmering Bee: Zigbee Device Adapter

Adapter to convert ZCL frames and queries into Shimmering Bee abstractions, written in Go.

Table of Contents

• Background
• Install
• Usage
• Maintainers
• Contributing
• License

Background

The Zigbee Device Adapter is a suite of libraries and functions to manage the abstraction from Zigbee Nodes to Shimmering Bee devices.

Install

Add an import and most IDEs will go get automatically, if it doesn't go build will fetch.

import "github.com/shimmeringbee/zda"

Usage

This libraries API is unstable and should not yet be relied upon.

This piece of software is not ready for general use.

Maintainers

@pwood

Contributing

Feel free to dive in! Open an issue or submit PRs.

All Shimmering Bee projects follow the Contributor Covenant Code of Conduct.

License

Copyright 2019-2020 Shimmering Bee Contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Documentation

Index

• Constants
• type IEEEAddressWithSubIdentifier
  • func (a IEEEAddressWithSubIdentifier) String() string
• type ZDA
  • func New(baseCtx context.Context, s persistence.Section, p zigbee.Provider, ...) *ZDA
  • func (z *ZDA) Capabilities() []da.Capability
  • func (z *ZDA) Devices() []da.Device
  • func (z *ZDA) ReadEvent(ctx context.Context) (any, error)
  • func (z *ZDA) Self() da.Device
  • func (z *ZDA) Start(ctx context.Context) error
  • func (z *ZDA) Stop(_ context.Context) error
  • func (z *ZDA) WithGoLogger(parentLogger *log.Logger)
  • func (z *ZDA) WithLogWrapLogger(lw logwrap.Logger)

Constants

const (
	EnumerationDurationMax    = 1 * time.Minute
	EnumerationNetworkTimeout = 2 * time.Second
	EnumerationNetworkRetries = 5
)

const DefaultGatewayHomeAutomationEndpoint = zigbee.Endpoint(0x01)

Types

type IEEEAddressWithSubIdentifier

type IEEEAddressWithSubIdentifier struct {
	IEEEAddress   zigbee.IEEEAddress
	SubIdentifier uint8
}

func (IEEEAddressWithSubIdentifier) String

func (a IEEEAddressWithSubIdentifier) String() string

type ZDA

type ZDA struct {
	// contains filtered or unexported fields
}

func New

func New(baseCtx context.Context, s persistence.Section, p zigbee.Provider, r ruleExecutor) *ZDA

func (*ZDA) Capabilities

func (z *ZDA) Capabilities() []da.Capability

func (*ZDA) Devices

func (z *ZDA) Devices() []da.Device

func (*ZDA) ReadEvent

func (z *ZDA) ReadEvent(ctx context.Context) (any, error)

func (*ZDA) Self

func (z *ZDA) Self() da.Device

func (*ZDA) Start

func (z *ZDA) Start(ctx context.Context) error

func (*ZDA) Stop

func (z *ZDA) Stop(_ context.Context) error

func (*ZDA) WithGoLogger

func (z *ZDA) WithGoLogger(parentLogger *log.Logger)

func (*ZDA) WithLogWrapLogger

func (z *ZDA) WithLogWrapLogger(lw logwrap.Logger)