common.go

package zigbee

import (
	"fmt"
	"math/rand"
	"time"
)

func init() {
	rand.Seed(time.Now().UnixNano())
}

type IEEEAddress uint64

func (a IEEEAddress) String() string {
	return fmt.Sprintf("%016x", uint64(a))
}

var EmptyIEEEAddress = IEEEAddress(0)

func GenerateLocalAdministeredIEEEAddress() IEEEAddress {
	// 0xbee5 happens to also be a Locally Administered EUI-64 address.
	prefix := uint64(0xbee5000000000000)
	mask := uint64(0x0000FFFFFFFFFFFF)

	return IEEEAddress(prefix | (rand.Uint64() & mask))
}

type NetworkAddress uint16

const (
	BroadcastAll                 NetworkAddress = 0xffff
	BroadcastAlwaysOnReceivers   NetworkAddress = 0xfffd
	BroadcastRoutersCoordinators NetworkAddress = 0xfffc
	BroadcastLowPowerRouters     NetworkAddress = 0xfffb
)

type PANID uint16
type ExtendedPANID uint64

type NetworkKey [16]byte

var TCLinkKey = NetworkKey{0x5a, 0x69, 0x67, 0x42, 0x65, 0x65, 0x41, 0x6c, 0x6c, 0x69, 0x61, 0x6e, 0x63, 0x65, 0x30, 0x39}

type ClusterID uint16

func (z ClusterID) IsManufacturerSpecific() bool {
	return z >= 0xfc00
}

type GroupID uint16

type ProfileID uint16

type ManufacturerCode uint16

const NoManufacturer = ManufacturerCode(0x0000)

const (
	ProfileIndustrialPlantMonitoring    ProfileID = 0x0101
	ProfileHomeAutomation               ProfileID = 0x0104
	ProfileCommercialBuildingAutomation ProfileID = 0x0105
	ProfileTelecomApplications          ProfileID = 0x0107
	ProfilePersonalHomeAndHospitalCare  ProfileID = 0x0108
	ProfileAdvancedMeteringInitiative   ProfileID = 0x0109
)

type Endpoint uint8

type LogicalType uint8

const (
	Coordinator LogicalType = 0x00
	Router      LogicalType = 0x01
	EndDevice   LogicalType = 0x02
	Unknown     LogicalType = 0xff
)

func (l LogicalType) String() string {
	switch l {
	case Coordinator:
		return "coordinator"
	case Router:
		return "router"
	case EndDevice:
		return "enddevice"
	default:
		return "Unknown"
	}
}

type Relationship uint8

const (
	RelationshipParent  Relationship = 0x00
	RelationshipChild   Relationship = 0x01
	RelationshipSibling Relationship = 0x02
	RelationshipUnknown Relationship = 0x03
)

type EndpointDescription struct {
	Endpoint       Endpoint
	ProfileID      ProfileID
	DeviceID       uint16
	DeviceVersion  uint8
	InClusterList  []ClusterID
	OutClusterList []ClusterID
}

type NodeDescription struct {
	LogicalType      LogicalType
	ManufacturerCode ManufacturerCode
}

// https://en.wikipedia.org/wiki/Zigbee#Radio_hardware
// https://acuitysupport.zendesk.com/hc/en-us/articles/225413967-Zigbee-Networking-Basics-35-000ft-view-
// https://community.smartthings.com/t/faq-networking-and-reducing-channel-interference-between-wifi-and-zigbee/40159
// https://www.metageek.com/training/resources/zigbee-wifi-coexistence.html
// https://www.researchgate.net/figure/WIFI-and-Zigbee-Overlapping-Channels-in-The-24Ghz-ISM-Band_fig1_265226405

// Channels 15, 20 and 25 are in the space between standard 20Mhz 802.11bg channels, so will be least likely to receive
// WiFi interference. Though 11 does clash slightly with Wifi Channel 1 lower sideband, thus default to channel 15.

// Channel 26 is also outside of US/EU WiFi clashes, however it's not supported on all Zigbee devices and is not
// recognised by ZLL as a valid channel.

var Channels = []uint8{11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26}
var ZLLChannels = []uint8{11, 15, 20, 25}
var DefaultChannel = ZLLChannels[1]

var ChannelToFrequencies = map[uint8]uint16{
	11: 2405,
	12: 2410,
	13: 2415,
	14: 2420,
	15: 2425,
	16: 2430,
	17: 2435,
	18: 2440,
	19: 2445,
	20: 2450,
	21: 2455,
	22: 2460,
	23: 2465,
	24: 2470,
	25: 2475,
	26: 2480,
}

// Error retypes a string so that constant errors can be used.
type Error string

// Error returns the reason for the error.
func (e Error) Error() string {
	return string(e)
}