adapter

package

Go to main page

Versions in this module

v0

v0.4.4

Feb 6, 2026

v0.4.3

Feb 6, 2026

v0.4.2

Feb 6, 2026

v0.4.1

Feb 6, 2026

v0.4.0

Feb 6, 2026

Changes in this version

type ZNPClient

+ NvLength func(ctx context.Context, id znp.NvItemID) (uint16, error)

v0.3.0

Feb 5, 2026

Changes in this version

+ const AddressModeGroup

+ const AddressModeIEEE

+ const BroadcastAddressNwk

+ const CoordinatorAddressNwk

+ const InvalidAddressNwk

+ const LogicalTypeCoordinator

+ const LogicalTypeEndDevice

+ const LogicalTypeRouter

+ const NvItemCoordinatorEP

+ const NvItemNIB

+ const NvItemNwkActiveKeyInfo

+ const ReportingDirectionDeviceToCoordinator

+ const StartupOptionClearState

+ const ZdoDirectCbEnabled

+ var ErrInvalidEndpoint = errors.New("invalid endpoint number")

+ var ErrInvalidIEEEAddress = errors.New("invalid IEEE address")

+ var ErrInvalidNetworkAddress = errors.New("invalid network address")

type Adapter

+ func (a *Adapter) GetZNP() ZNPClient

+ type DefaultLogger struct

+ func (l *DefaultLogger) Debugf(format string, args ...interface{})

+ func (l *DefaultLogger) Errorf(format string, args ...interface{})

+ func (l *DefaultLogger) Infof(format string, args ...interface{})

+ func (l *DefaultLogger) Warnf(format string, args ...interface{})

+ type Logger interface

+ Debugf func(format string, args ...interface{})

+ Errorf func(format string, args ...interface{})

+ Infof func(format string, args ...interface{})

+ Warnf func(format string, args ...interface{})

type Option

+ func WithLogger(logger Logger) Option

+ func WithZCLRetryAttempts(attempts int) Option

+ func WithZCLRetryDelay(delay time.Duration) Option

+ func WithZDOInitDelay(delay time.Duration) Option

type Options

+ Logger Logger

+ ZCLRetryAttempts int

+ ZCLRetryDelay time.Duration

+ ZDOInitDelay time.Duration

+ type SlogLogger struct

+ func NewSlogLogger(logger *slog.Logger) *SlogLogger

+ func (l *SlogLogger) Debugf(format string, args ...any)

+ func (l *SlogLogger) Errorf(format string, args ...any)

+ func (l *SlogLogger) Infof(format string, args ...any)

+ func (l *SlogLogger) Warnf(format string, args ...any)

v0.2.1

Jan 7, 2026

Changes in this version

type PriceInfo

+ IssuerEventID uint32

+ ProviderID uint32

v0.2.0

Jan 7, 2026

Changes in this version

+ var ErrAttributeNotSupported = errors.New("adapter: attribute not supported")

+ var ErrBindingFailed = errors.New("adapter: binding failed")

+ var ErrClusterNotSupported = errors.New("adapter: cluster not supported by device")

+ var ErrDeviceNotFound = errors.New("adapter: device not found")

+ var ErrDeviceSleeping = errors.New("adapter: device is sleeping")

+ var ErrEndpointNotFound = errors.New("adapter: endpoint not found")

+ var ErrInvalidResponse = errors.New("adapter: invalid response")

+ var ErrNetworkNotFormed = errors.New("adapter: network not formed")

+ var ErrPermitJoinDisabled = errors.New("adapter: permit join disabled")

+ var ErrReportingConfigFailed = errors.New("adapter: reporting configuration failed")

+ var ErrTransactionTimeout = errors.New("adapter: transaction timeout")

+ func ExtractBool(v interface{}) (bool, bool)

+ func ExtractFloat32(v interface{}) (float32, bool)

+ func ExtractInt16(v interface{}) (int16, bool)

+ func ExtractInt32(v interface{}) (int32, bool)

+ func ExtractInt8(v interface{}) (int8, bool)

+ func ExtractString(v interface{}) (string, bool)

+ func ExtractUint16(v interface{}) (uint16, bool)

+ func ExtractUint32(v interface{}) (uint32, bool)

+ func ExtractUint48(v interface{}) (uint64, bool)

+ func ExtractUint8(v interface{}) (uint8, bool)

type Adapter

+ func (a *Adapter) GetDeviceHealth(ctx context.Context, nwkAddr uint16) (*DeviceHealth, error)

+ func (a *Adapter) GetNetworkHealth(ctx context.Context) (*NetworkHealth, error)

+ func (a *Adapter) GetRoutingTable(ctx context.Context, nwkAddr uint16) ([]RoutingInfo, error)

+ func (a *Adapter) ReadAttributeBool(ctx context.Context, nwkAddr uint16, endpoint uint8, cluster zcl.ClusterID, ...) (bool, error)

+ func (a *Adapter) ReadAttributeFloat32(ctx context.Context, nwkAddr uint16, endpoint uint8, cluster zcl.ClusterID, ...) (float32, error)

+ func (a *Adapter) ReadAttributeInt16(ctx context.Context, nwkAddr uint16, endpoint uint8, cluster zcl.ClusterID, ...) (int16, error)

+ func (a *Adapter) ReadAttributeInt32(ctx context.Context, nwkAddr uint16, endpoint uint8, cluster zcl.ClusterID, ...) (int32, error)

+ func (a *Adapter) ReadAttributeInt8(ctx context.Context, nwkAddr uint16, endpoint uint8, cluster zcl.ClusterID, ...) (int8, error)

+ func (a *Adapter) ReadAttributeString(ctx context.Context, nwkAddr uint16, endpoint uint8, cluster zcl.ClusterID, ...) (string, error)

+ func (a *Adapter) ReadAttributeUint16(ctx context.Context, nwkAddr uint16, endpoint uint8, cluster zcl.ClusterID, ...) (uint16, error)

+ func (a *Adapter) ReadAttributeUint32(ctx context.Context, nwkAddr uint16, endpoint uint8, cluster zcl.ClusterID, ...) (uint32, error)

+ func (a *Adapter) ReadAttributeUint48(ctx context.Context, nwkAddr uint16, endpoint uint8, cluster zcl.ClusterID, ...) (uint64, error)

+ func (a *Adapter) ReadAttributeUint8(ctx context.Context, nwkAddr uint16, endpoint uint8, cluster zcl.ClusterID, ...) (uint8, error)

type AttributeResult

+ func GetFirstResult(results []AttributeResult) (*AttributeResult, error)

+ type DeviceHealth struct

+ Depth uint8

+ IEEEAddr [8]byte

+ IsReachable bool

+ LQI uint8

+ LastSeen time.Time

+ NeighborCount int

+ NwkAddr uint16

+ RouteCount int

type DeviceNameInfo

+ Comment string

+ type NetworkHealth struct

+ AverageLQI uint8

+ Channel uint8

+ DeviceCount int

+ EndDeviceCount int

+ MaxLQI uint8

+ MinLQI uint8

+ PanID uint16

+ RouterCount int

+ Timestamp time.Time

+ Topology []TopologyNode

+ WeakLinks []WeakLink

+ type RoutingInfo struct

+ Concentrator bool

+ DstAddr uint16

+ ManyToOne bool

+ NextHop uint16

+ RouteRecord bool

+ Status uint8

+ type TopologyNode struct

+ Children []uint16

+ Depth uint8

+ DeviceType uint8

+ IEEEAddr [8]byte

+ LQI uint8

+ NwkAddr uint16

+ ParentAddr uint16

+ type WeakLink struct

+ FromAddr uint16

+ LQI uint8

+ ToAddr uint16

+ type ZNPClient interface

+ ActiveEpReq func(ctx context.Context, dstAddr uint16) (*znp.ActiveEndpoints, error)

+ AfDataRequest func(ctx context.Context, req znp.DataRequest) (uint8, error)

+ AfDelete func(ctx context.Context, endpoint uint8) (uint8, error)

+ AfRegister func(ctx context.Context, config znp.EndpointConfig) (uint8, error)

+ BdbSetChannel func(ctx context.Context, isPrimary bool, channel uint32) (uint8, error)

+ BdbStartCommissioning func(ctx context.Context, mode znp.BdbCommissioningMode) (uint8, error)

+ BindReq func(ctx context.Context, dstAddr uint16, srcIEEEAddr [8]byte, srcEndpoint uint8, ...) (uint8, error)

+ Close func() error

+ DeleteAddrMgrEntry func(ctx context.Context, ieeeAddr [8]byte) (bool, error)

+ DeleteDeviceName func(ctx context.Context, ieeeAddr [8]byte) error

+ ExtNwkInfo func(ctx context.Context) (*znp.ExtNetworkInfo, error)

+ GetAllBindings func(ctx context.Context, dstAddr uint16) ([]znp.BindingEntry, error)

+ GetAllNeighbors func(ctx context.Context, dstAddr uint16) ([]znp.NeighborEntry, error)

+ GetAllRoutes func(ctx context.Context, dstAddr uint16) ([]znp.RoutingEntry, error)

+ GetDeviceInfo func(ctx context.Context) (*znp.DeviceInfo, error)

+ GetDeviceName func(ctx context.Context, ieeeAddr [8]byte) (*znp.DeviceNameEntry, error)

+ IeeeAddrReq func(ctx context.Context, nwkAddr uint16) ([8]byte, error)

+ MgmtLeaveReq func(ctx context.Context, dstAddr uint16, ieeeAddr [8]byte, ...) (uint8, error)

+ MgmtNwkUpdateReq func(ctx context.Context, dstAddr uint16, dstAddrMode uint8, channelMask uint32, ...) (uint8, error)

+ MgmtPermitJoinReq func(ctx context.Context, duration uint8) (uint8, error)

+ NodeDescReq func(ctx context.Context, dstAddr uint16) (*znp.NodeDescriptor, error)

+ NvItemInit func(ctx context.Context, id znp.NvItemID, itemLen uint16, initData []byte) error

+ NvRead func(ctx context.Context, id znp.NvItemID, offset uint8) ([]byte, error)

+ NvReadAll func(ctx context.Context, id znp.NvItemID) ([]byte, error)

+ NvWrite func(ctx context.Context, id znp.NvItemID, offset uint8, data []byte) error

+ NvWriteAll func(ctx context.Context, id znp.NvItemID, data []byte) error

+ OnDeviceAnnounce func(handler func(*znp.DeviceAnnounce))

+ OnDeviceJoin func(handler func(*znp.TcDeviceInd))

+ OnDeviceLeave func(handler func(*znp.DeviceLeave))

+ Open func(ctx context.Context) error

+ Ping func(ctx context.Context) (*znp.PingCapabilities, error)

+ ReadAddrMgrTable func(ctx context.Context) ([]znp.AddrMgrEntry, error)

+ ReadDeviceNameTable func(ctx context.Context) (*znp.DeviceNameTable, error)

+ Reset func(ctx context.Context, resetType znp.ResetType) (*znp.ResetIndication, error)

+ SetDeviceName func(ctx context.Context, ieeeAddr [8]byte, name, comment string) error

+ SetTxPower func(ctx context.Context, power int8) (int8, error)

+ SimpleDescReq func(ctx context.Context, dstAddr uint16, endpoint uint8) (*znp.SimpleDescriptor, error)

+ StartupFromApp func(ctx context.Context, startDelay uint16) (uint8, error)

+ UnbindReq func(ctx context.Context, dstAddr uint16, srcIEEEAddr [8]byte, srcEndpoint uint8, ...) (uint8, error)

+ Version func(ctx context.Context) (*znp.VersionInfo, error)

+ WaitForDataConfirm func(ctx context.Context, transID uint8, timeout time.Duration) (*znp.DataConfirm, error)

+ WaitForIncomingMsg func(ctx context.Context, srcAddr uint16, clusterID uint16, timeout time.Duration) (*znp.IncomingMessage, error)

+ WaitForStateChange func(ctx context.Context, timeout time.Duration) (znp.DevState, error)

v0.1.3

Jan 3, 2026

v0.1.2

Jan 3, 2026

v0.1.1

Jan 3, 2026

v0.1.0

Jan 3, 2026

Changes in this version

+ const CoordinatorEndpoint

+ const DedupeWindow

+ const StatusAlreadyRegistered

+ const StatusSuccess

+ var CoordinatorEndpoints = []EndpointDef

+ var ErrNotOpen = errors.New("adapter not open")

+ var ProfileToEndpoint = map[znp.ApplicationProfile]uint8

+ func GetEndpointForProfile(profile znp.ApplicationProfile) uint8

+ func QuarterSecondsToSeconds(quarterSecs uint32) float64

+ func SecondsToQuarterSeconds(secs float64) uint32

+ func SupportedProfiles() []znp.ApplicationProfile

+ func UnixToZigbeeTime(t time.Time) uint32

+ func ZigbeeTimeToUnix(zigbeeTime uint32) time.Time

+ type Adapter struct

+ func New(opts ...Option) *Adapter

+ func (a *Adapter) AddScene(ctx context.Context, nwkAddr uint16, endpoint uint8, groupID uint16, ...) error

+ func (a *Adapter) AddToGroup(ctx context.Context, nwkAddr uint16, endpoint uint8, groupID uint16, ...) error

+ func (a *Adapter) AdjustThermostatSetpoint(ctx context.Context, nwkAddr uint16, endpoint uint8, mode uint8, amount int8) error

+ func (a *Adapter) Bind(ctx context.Context, deviceIEEEAddr [8]byte, deviceNwkAddr uint16, ...) error

+ func (a *Adapter) CancelSEMessage(ctx context.Context, nwkAddr uint16, endpoint uint8, messageID uint32) error

+ func (a *Adapter) ChangeChannel(ctx context.Context, channel uint8, seamless bool) error

+ func (a *Adapter) ClearDoorLockPIN(ctx context.Context, nwkAddr uint16, endpoint uint8, userID uint16) error

+ func (a *Adapter) Close() error

+ func (a *Adapter) CloseWindowCovering(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) ConfigureReporting(ctx context.Context, nwkAddr uint16, endpoint uint8, clusterID zcl.ClusterID, ...) error

+ func (a *Adapter) CreateBackup(ctx context.Context) (*backup.Backup, error)

+ func (a *Adapter) DeleteDeviceName(ctx context.Context, ieeeAddr [8]byte) error

+ func (a *Adapter) DisplaySEMessage(ctx context.Context, nwkAddr uint16, endpoint uint8, msg SEMessage) error

+ func (a *Adapter) EnrollIASZone(ctx context.Context, nwkAddr uint16, endpoint uint8, responseCode uint8, ...) error

+ func (a *Adapter) FactoryReset(ctx context.Context) error

+ func (a *Adapter) ForceRemoveDevice(ctx context.Context, ieeeAddr [8]byte) error

+ func (a *Adapter) FormNetwork(ctx context.Context, config NetworkFormConfig) error

+ func (a *Adapter) GetActiveEndpoints(ctx context.Context, nwkAddr uint16) ([]uint8, error)

+ func (a *Adapter) GetAirQuality(ctx context.Context, nwkAddr uint16, endpoint uint8) (*AirQualityData, error)

+ func (a *Adapter) GetAlarm(ctx context.Context, nwkAddr uint16, endpoint uint8) (*AlarmEntry, error)

+ func (a *Adapter) GetAlarmCount(ctx context.Context, nwkAddr uint16, endpoint uint8) (uint16, error)

+ func (a *Adapter) GetAnalogInput(ctx context.Context, nwkAddr uint16, endpoint uint8) (*AnalogInputInfo, error)

+ func (a *Adapter) GetAnalogInputValue(ctx context.Context, nwkAddr uint16, endpoint uint8) (float32, error)

+ func (a *Adapter) GetAnalogOutput(ctx context.Context, nwkAddr uint16, endpoint uint8) (*AnalogOutputInfo, error)

+ func (a *Adapter) GetAnalogOutputValue(ctx context.Context, nwkAddr uint16, endpoint uint8) (float32, error)

+ func (a *Adapter) GetAnalogValue(ctx context.Context, nwkAddr uint16, endpoint uint8) (*AnalogValueInfo, error)

+ func (a *Adapter) GetBatteryInfo(ctx context.Context, nwkAddr uint16, endpoint uint8) (*BatteryInfo, error)

+ func (a *Adapter) GetBinaryInput(ctx context.Context, nwkAddr uint16, endpoint uint8) (*BinaryInputInfo, error)

+ func (a *Adapter) GetBinaryInputValue(ctx context.Context, nwkAddr uint16, endpoint uint8) (bool, error)

+ func (a *Adapter) GetBinaryOutput(ctx context.Context, nwkAddr uint16, endpoint uint8) (*BinaryOutputInfo, error)

+ func (a *Adapter) GetBinaryOutputValue(ctx context.Context, nwkAddr uint16, endpoint uint8) (bool, error)

+ func (a *Adapter) GetBinaryValue(ctx context.Context, nwkAddr uint16, endpoint uint8) (*BinaryValueInfo, error)

+ func (a *Adapter) GetBindingTable(ctx context.Context, nwkAddr uint16) ([]BindingInfo, error)

+ func (a *Adapter) GetBrightness(ctx context.Context, nwkAddr uint16, endpoint uint8) (uint8, error)

+ func (a *Adapter) GetCO2Level(ctx context.Context, nwkAddr uint16, endpoint uint8) (*float32, error)

+ func (a *Adapter) GetColor(ctx context.Context, nwkAddr uint16, endpoint uint8) (*ColorState, error)

+ func (a *Adapter) GetColorTempInfo(ctx context.Context, nwkAddr uint16, endpoint uint8) (*ColorTempInfo, error)

+ func (a *Adapter) GetColorTemperature(ctx context.Context, nwkAddr uint16, endpoint uint8) (uint16, error)

+ func (a *Adapter) GetCoordinatorIEEE(ctx context.Context) ([8]byte, error)

+ func (a *Adapter) GetCurrentChannel(ctx context.Context) (uint8, error)

+ func (a *Adapter) GetCurrentPrice(ctx context.Context, nwkAddr uint16, endpoint uint8) (*PriceInfo, error)

+ func (a *Adapter) GetDRLCInfo(ctx context.Context, nwkAddr uint16, endpoint uint8) (*DRLCEventInfo, error)

+ func (a *Adapter) GetDevice(ieeeAddr [8]byte) *Device

+ func (a *Adapter) GetDeviceByNwkAddr(nwkAddr uint16) *Device

+ func (a *Adapter) GetDeviceCapabilities(ctx context.Context, nwkAddr uint16) (*DeviceCapabilities, error)

+ func (a *Adapter) GetDeviceName(ctx context.Context, ieeeAddr [8]byte) (*DeviceNameInfo, error)

+ func (a *Adapter) GetDeviceStatus(ctx context.Context, nwkAddr uint16, endpoint uint8) (*DeviceStatus, error)

+ func (a *Adapter) GetDevices(ctx context.Context) ([]*Device, error)

+ func (a *Adapter) GetDoorLockStatus(ctx context.Context, nwkAddr uint16, endpoint uint8) (*DoorLockStatus, error)

+ func (a *Adapter) GetEndpointForProfile(profile znp.ApplicationProfile) uint8

+ func (a *Adapter) GetFanStatus(ctx context.Context, nwkAddr uint16, endpoint uint8) (*FanStatus, error)

+ func (a *Adapter) GetGroupMembership(ctx context.Context, nwkAddr uint16, endpoint uint8) (*GroupMembership, error)

+ func (a *Adapter) GetIASZoneStatus(ctx context.Context, nwkAddr uint16, endpoint uint8) (*IASZoneStatus, error)

+ func (a *Adapter) GetInfo(ctx context.Context) (*Info, error)

+ func (a *Adapter) GetLastSEMessage(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) GetMainsInfo(ctx context.Context, nwkAddr uint16, endpoint uint8) (*MainsInfo, error)

+ func (a *Adapter) GetMultistateInput(ctx context.Context, nwkAddr uint16, endpoint uint8) (*MultistateInputInfo, error)

+ func (a *Adapter) GetMultistateInputValue(ctx context.Context, nwkAddr uint16, endpoint uint8) (uint16, error)

+ func (a *Adapter) GetMultistateOutput(ctx context.Context, nwkAddr uint16, endpoint uint8) (*MultistateOutputInfo, error)

+ func (a *Adapter) GetMultistateValue(ctx context.Context, nwkAddr uint16, endpoint uint8) (*MultistateValueInfo, error)

+ func (a *Adapter) GetNeighborTable(ctx context.Context, nwkAddr uint16) ([]NeighborInfo, error)

+ func (a *Adapter) GetNetworkInfo(ctx context.Context) (*NetworkInfo, error)

+ func (a *Adapter) GetOTAInfo(ctx context.Context, nwkAddr uint16, endpoint uint8) (*OTAInfo, error)

+ func (a *Adapter) GetOTAUpgradeStatus(ctx context.Context, nwkAddr uint16, endpoint uint8) (zcl.OTAUpgradeStatus, error)

+ func (a *Adapter) GetOnOffState(ctx context.Context, nwkAddr uint16, endpoint uint8) (bool, error)

+ func (a *Adapter) GetPM25Level(ctx context.Context, nwkAddr uint16, endpoint uint8) (*float32, error)

+ func (a *Adapter) GetPollControlInfo(ctx context.Context, nwkAddr uint16, endpoint uint8) (*PollControlInfo, error)

+ func (a *Adapter) GetPressure(ctx context.Context, nwkAddr uint16, endpoint uint8) (*PressureData, error)

+ func (a *Adapter) GetSceneMembership(ctx context.Context, nwkAddr uint16, endpoint uint8, groupID uint16) (*SceneMembership, error)

+ func (a *Adapter) GetSimpleDescriptor(ctx context.Context, nwkAddr uint16, endpoint uint8) (*EndpointDescriptor, error)

+ func (a *Adapter) GetThermostatStatus(ctx context.Context, nwkAddr uint16, endpoint uint8) (*ThermostatStatus, error)

+ func (a *Adapter) GetTime(ctx context.Context, nwkAddr uint16, endpoint uint8) (*TimeInfo, error)

+ func (a *Adapter) GetTimeZone(ctx context.Context, nwkAddr uint16, endpoint uint8) (int32, error)

+ func (a *Adapter) GetTxPower(ctx context.Context) (int8, error)

+ func (a *Adapter) GetWindowCoveringStatus(ctx context.Context, nwkAddr uint16, endpoint uint8) (*WindowCoveringStatus, error)

+ func (a *Adapter) GroupRecallScene(ctx context.Context, groupID uint16, sceneID uint8) error

+ func (a *Adapter) GroupSetBrightness(ctx context.Context, groupID uint16, level uint8, transitionTime uint16) error

+ func (a *Adapter) GroupToggle(ctx context.Context, groupID uint16) error

+ func (a *Adapter) GroupTurnOff(ctx context.Context, groupID uint16) error

+ func (a *Adapter) GroupTurnOn(ctx context.Context, groupID uint16) error

+ func (a *Adapter) Identify(ctx context.Context, nwkAddr uint16, endpoint uint8, durationSecs uint16) error

+ func (a *Adapter) InterviewAllDevices(ctx context.Context) ([]*InterviewResult, error)

+ func (a *Adapter) InterviewAllDevicesWithOptions(ctx context.Context, opts InterviewOptions) ([]*InterviewResult, error)

+ func (a *Adapter) InterviewDevice(ctx context.Context, nwkAddr uint16) (*InterviewResult, error)

+ func (a *Adapter) InterviewDeviceByIEEE(ctx context.Context, ieeeAddr [8]byte) (*InterviewResult, error)

+ func (a *Adapter) InterviewDeviceWithAddr(ctx context.Context, nwkAddr uint16, ieeeAddr [8]byte) (*InterviewResult, error)

+ func (a *Adapter) InterviewDeviceWithOptions(ctx context.Context, nwkAddr uint16, opts InterviewOptions) (*InterviewResult, error)

+ func (a *Adapter) IsOpen() bool

+ func (a *Adapter) ListDeviceNames(ctx context.Context) ([]DeviceNameInfo, error)

+ func (a *Adapter) LockDoor(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) MoveLevel(ctx context.Context, nwkAddr uint16, endpoint uint8, moveMode, rate uint8) error

+ func (a *Adapter) OffWithEffect(ctx context.Context, nwkAddr uint16, endpoint uint8, ...) error

+ func (a *Adapter) OnDeviceEvent(handler func(DeviceEvent))

+ func (a *Adapter) OnWithTimedOff(ctx context.Context, nwkAddr uint16, endpoint uint8, ...) error

+ func (a *Adapter) Open(ctx context.Context) error

+ func (a *Adapter) OpenWindowCovering(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) PermitJoin(ctx context.Context, duration uint8) error

+ func (a *Adapter) Ping(ctx context.Context) (*znp.PingCapabilities, error)

+ func (a *Adapter) ReadAttributes(ctx context.Context, nwkAddr uint16, endpoint uint8, clusterID zcl.ClusterID, ...) ([]AttributeResult, error)

+ func (a *Adapter) ReadDeviceInfo(ctx context.Context, nwkAddr uint16, endpoint uint8) (*DeviceInfo, error)

+ func (a *Adapter) ReadPowerData(ctx context.Context, nwkAddr uint16, endpoint uint8) (*PowerData, error)

+ func (a *Adapter) ReadReportingConfig(ctx context.Context, nwkAddr uint16, endpoint uint8, clusterID zcl.ClusterID, ...) ([]ReportingConfigResult, error)

+ func (a *Adapter) ReadSensorData(ctx context.Context, nwkAddr uint16, endpoint uint8) (*SensorData, error)

+ func (a *Adapter) RecallScene(ctx context.Context, nwkAddr uint16, endpoint uint8, groupID uint16, ...) error

+ func (a *Adapter) RegisteredProfiles() []znp.ApplicationProfile

+ func (a *Adapter) RemoveAllScenes(ctx context.Context, nwkAddr uint16, endpoint uint8, groupID uint16) error

+ func (a *Adapter) RemoveDevice(ctx context.Context, nwkAddr uint16, ieeeAddr [8]byte, ...) error

+ func (a *Adapter) RemoveFromAllGroups(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) RemoveFromGroup(ctx context.Context, nwkAddr uint16, endpoint uint8, groupID uint16) error

+ func (a *Adapter) RemoveScene(ctx context.Context, nwkAddr uint16, endpoint uint8, groupID uint16, ...) error

+ func (a *Adapter) Reset(ctx context.Context) error

+ func (a *Adapter) ResetAlarm(ctx context.Context, nwkAddr uint16, endpoint uint8, alarmCode uint8, ...) error

+ func (a *Adapter) ResetAlarmLog(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) ResetAllAlarms(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) ResetEnergy(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) ResetToFactoryDefaults(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) RestoreBackup(ctx context.Context, b *backup.Backup) error

+ func (a *Adapter) SendCheckInResponse(ctx context.Context, nwkAddr uint16, endpoint uint8, startFastPolling bool, ...) error

+ func (a *Adapter) SendClusterCommand(ctx context.Context, nwkAddr uint16, endpoint uint8, clusterID zcl.ClusterID, ...) error

+ func (a *Adapter) SendGroupCommand(ctx context.Context, groupID uint16, clusterID zcl.ClusterID, commandID uint8, ...) error

+ func (a *Adapter) SetAnalogOutput(ctx context.Context, nwkAddr uint16, endpoint uint8, value float32) error

+ func (a *Adapter) SetAnalogValue(ctx context.Context, nwkAddr uint16, endpoint uint8, value float32) error

+ func (a *Adapter) SetBinaryOutput(ctx context.Context, nwkAddr uint16, endpoint uint8, value bool) error

+ func (a *Adapter) SetBinaryValue(ctx context.Context, nwkAddr uint16, endpoint uint8, value bool) error

+ func (a *Adapter) SetBrightness(ctx context.Context, nwkAddr uint16, endpoint uint8, level uint8, ...) error

+ func (a *Adapter) SetColorKelvin(ctx context.Context, nwkAddr uint16, endpoint uint8, kelvin uint16, ...) error

+ func (a *Adapter) SetColorRGB(ctx context.Context, nwkAddr uint16, endpoint uint8, r, g, b uint8, ...) error

+ func (a *Adapter) SetColorTemperature(ctx context.Context, nwkAddr uint16, endpoint uint8, tempMireds uint16, ...) error

+ func (a *Adapter) SetColorXY(ctx context.Context, nwkAddr uint16, endpoint uint8, x uint16, y uint16, ...) error

+ func (a *Adapter) SetDeviceName(ctx context.Context, ieeeAddr [8]byte, name, description string) error

+ func (a *Adapter) SetDoorLockPIN(ctx context.Context, nwkAddr uint16, endpoint uint8, userID uint16, pin string) error

+ func (a *Adapter) SetFanMode(ctx context.Context, nwkAddr uint16, endpoint uint8, mode zcl.FanMode) error

+ func (a *Adapter) SetFanSpeed(ctx context.Context, nwkAddr uint16, endpoint uint8, percent uint8) error

+ func (a *Adapter) SetHue(ctx context.Context, nwkAddr uint16, endpoint uint8, hue uint8, ...) error

+ func (a *Adapter) SetHueSaturation(ctx context.Context, nwkAddr uint16, endpoint uint8, hue uint8, ...) error

+ func (a *Adapter) SetLongPollInterval(ctx context.Context, nwkAddr uint16, endpoint uint8, ...) error

+ func (a *Adapter) SetMultistateOutput(ctx context.Context, nwkAddr uint16, endpoint uint8, value uint16) error

+ func (a *Adapter) SetMultistateValue(ctx context.Context, nwkAddr uint16, endpoint uint8, value uint16) error

+ func (a *Adapter) SetSaturation(ctx context.Context, nwkAddr uint16, endpoint uint8, saturation uint8, ...) error

+ func (a *Adapter) SetShortPollInterval(ctx context.Context, nwkAddr uint16, endpoint uint8, ...) error

+ func (a *Adapter) SetStartupLevel(ctx context.Context, nwkAddr uint16, endpoint uint8, level uint8) error

+ func (a *Adapter) SetStartupOnOff(ctx context.Context, nwkAddr uint16, endpoint uint8, value uint8) error

+ func (a *Adapter) SetThermostatMode(ctx context.Context, nwkAddr uint16, endpoint uint8, ...) error

+ func (a *Adapter) SetThermostatSetpoint(ctx context.Context, nwkAddr uint16, endpoint uint8, heating, cooling float64) error

+ func (a *Adapter) SetTime(ctx context.Context, nwkAddr uint16, endpoint uint8, zigbeeTime uint32) error

+ func (a *Adapter) SetTimeZone(ctx context.Context, nwkAddr uint16, endpoint uint8, offsetSeconds int32) error

+ func (a *Adapter) SetTxPower(ctx context.Context, power int8) error

+ func (a *Adapter) SetWindowCoveringPosition(ctx context.Context, nwkAddr uint16, endpoint uint8, percent uint8) error

+ func (a *Adapter) SetWindowCoveringTilt(ctx context.Context, nwkAddr uint16, endpoint uint8, percent uint8) error

+ func (a *Adapter) Squawk(ctx context.Context, nwkAddr uint16, endpoint uint8, mode uint8, ...) error

+ func (a *Adapter) StartWarning(ctx context.Context, nwkAddr uint16, endpoint uint8, mode zcl.WarningMode, ...) error

+ func (a *Adapter) StepLevel(ctx context.Context, nwkAddr uint16, endpoint uint8, stepMode, stepSize uint8, ...) error

+ func (a *Adapter) StopFastPolling(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) StopLevel(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) StopWarning(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) StopWindowCovering(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) StoreScene(ctx context.Context, nwkAddr uint16, endpoint uint8, groupID uint16, ...) error

+ func (a *Adapter) Toggle(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) ToggleDoorLock(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) TriggerEffect(ctx context.Context, nwkAddr uint16, endpoint uint8, effectID uint8, ...) error

+ func (a *Adapter) TurnOff(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) TurnOn(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) Unbind(ctx context.Context, deviceIEEEAddr [8]byte, deviceNwkAddr uint16, ...) error

+ func (a *Adapter) UnlockDoor(ctx context.Context, nwkAddr uint16, endpoint uint8) error

+ func (a *Adapter) UnlockDoorWithTimeout(ctx context.Context, nwkAddr uint16, endpoint uint8, timeoutSeconds uint16) error

+ func (a *Adapter) Version() *znp.VersionInfo

+ func (a *Adapter) WaitForIASZoneNotification(ctx context.Context, timeout time.Duration) (*IASZoneNotification, error)

+ func (a *Adapter) WaitForSensorReport(ctx context.Context, timeout time.Duration) (*SensorReport, error)

+ func (a *Adapter) WriteAttributes(ctx context.Context, nwkAddr uint16, endpoint uint8, clusterID zcl.ClusterID, ...) error

+ func (a *Adapter) WriteIASZoneCIEAddress(ctx context.Context, nwkAddr uint16, endpoint uint8, cieAddress [8]byte) error

+ type AirQualityData struct

+ CO *float32

+ CO2 *float32

+ Formaldehyde *float32

+ PM25 *float32

+ type AlarmEntry struct

+ AlarmCode uint8

+ ClusterID zcl.ClusterID

+ Timestamp uint32

+ type AnalogInputInfo struct

+ EngineeringUnits zcl.EngineeringUnits

+ MaxValue float32

+ MinValue float32

+ OutOfService bool

+ PresentValue float32

+ StatusFlags uint8

+ type AnalogOutputInfo struct

+ EngineeringUnits zcl.EngineeringUnits

+ MaxValue float32

+ MinValue float32

+ OutOfService bool

+ PresentValue float32

+ StatusFlags uint8

+ type AnalogValueInfo struct

+ EngineeringUnits zcl.EngineeringUnits

+ OutOfService bool

+ PresentValue float32

+ StatusFlags uint8

+ type AttributeResult struct

+ AttributeID zcl.AttributeID

+ DataType zcl.DataType

+ Status uint8

+ Value interface{}

+ type BatteryInfo struct

+ LowBattery bool

+ Percentage *uint8

+ Voltage *float64

+ type BinaryInputInfo struct

+ OutOfService bool

+ PresentValue bool

+ Reliability zcl.IOReliability

+ StatusFlags uint8

+ type BinaryOutputInfo struct

+ OutOfService bool

+ Polarity uint8

+ PresentValue bool

+ StatusFlags uint8

+ type BinaryValueInfo struct

+ OutOfService bool

+ PresentValue bool

+ Reliability zcl.IOReliability

+ StatusFlags uint8

+ type BindingInfo struct

+ ClusterID uint16

+ DstAddr [8]byte

+ DstAddrMode uint8

+ DstEndpoint uint8

+ SrcAddr [8]byte

+ SrcEndpoint uint8

+ type ColorState struct

+ ColorMode uint8

+ Hue uint8

+ Saturation uint8

+ X uint16

+ Y uint16

+ type ColorTempInfo struct

+ CurrentMireds uint16

+ MaxMireds uint16

+ MinMireds uint16

+ type DRLCEventInfo struct

+ CoolingOffset uint8

+ CriticalityLevel uint8

+ DeviceClass uint16

+ Duration uint16

+ HeatingOffset uint8

+ IssuerEventID uint32

+ StartTime uint32

+ UtilityGroupID uint8

+ type Device struct

+ Capabilities uint8

+ Endpoints []uint8

+ IEEEAddr [8]byte

+ LastSeen time.Time

+ NwkAddr uint16

+ func (d *Device) IsBatteryPowered() bool

+ func (d *Device) IsRouter() bool

+ type DeviceCapabilities struct

+ Endpoints []*EndpointDescriptor

+ NwkAddr uint16

+ type DeviceEvent struct

+ Device *Device

+ IEEEAddr [8]byte

+ Type DeviceEventType

+ type DeviceEventType int

+ const DeviceEventJoined

+ const DeviceEventLeft

+ type DeviceInfo struct

+ AlarmMask *uint8

+ AppVersion *uint8

+ DateCode *string

+ DeviceEnabled *bool

+ DisableLocalConfig *uint8

+ GenericDeviceClass *uint8

+ GenericDeviceType *uint8

+ HWVersion *uint8

+ LocationDescription *string

+ ManufacturerName *string

+ ManufacturerVersionDetails *string

+ ModelIdentifier *string

+ PhysicalEnvironment *uint8

+ PowerSource *zcl.PowerSource

+ ProductCode *string

+ ProductLabel *string

+ ProductURL *string

+ SWBuildID *string

+ SerialNumber *string

+ StackVersion *uint8

+ ZCLVersion *uint8

+ type DeviceNameInfo struct

+ Description string

+ IEEEAddr [8]byte

+ Name string

+ func (d *DeviceNameInfo) IEEEAddrString() string

+ type DeviceStatus struct

+ BatteryPercent *uint8

+ Manufacturer string

+ Model string

+ NwkAddr uint16

+ OnOff *bool

+ PowerSource zcl.PowerSource

+ type DeviceType uint8

+ const DeviceTypeCoordinator

+ const DeviceTypeEndDevice

+ const DeviceTypeRouter

+ func (dt DeviceType) String() string

+ type DoorLockStatus struct

+ ActuatorEnabled bool

+ AutoRelockTime *uint32

+ DoorState *zcl.DoorState

+ LockState zcl.DoorLockState

+ type EndpointDef struct

+ DeviceID uint16

+ Endpoint uint8

+ InClusters []uint16

+ OutClusters []uint16

+ ProfileID znp.ApplicationProfile

+ type EndpointDescriptor struct

+ DeviceID uint16

+ DeviceVersion uint8

+ Endpoint uint8

+ InClusters []uint16

+ OutClusters []uint16

+ ProfileID uint16

+ type EndpointInfo struct

+ DeviceID uint16

+ DeviceVersion uint8

+ Endpoint uint8

+ InClusters []uint16

+ OutClusters []uint16

+ ProfileID uint16

+ func (e *EndpointInfo) HasCluster(clusterID uint16) bool

+ type FanStatus struct

+ Mode *zcl.FanMode

+ ModeSequence *zcl.FanModeSequence

+ PercentCurrent *uint8

+ PercentSetting *uint8

+ SpeedCurrent *uint8

+ SpeedMax *uint8

+ SpeedSetting *uint8

+ type GroupMembership struct

+ Capacity uint8

+ Groups []uint16

+ type IASZoneNotification struct

+ ACMains bool

+ Alarm1 bool

+ Alarm2 bool

+ BatteryDefect bool

+ Delay uint16

+ Endpoint uint8

+ ExtStatus uint8

+ LowBattery bool

+ SrcAddr uint16

+ Tamper bool

+ Test bool

+ Trouble bool

+ ZoneID uint8

+ ZoneStatus uint16

+ type IASZoneStatus struct

+ ACMains bool

+ Alarm1 bool

+ Alarm2 bool

+ BatteryDefect bool

+ CIEAddress *[8]byte

+ LowBattery bool

+ Tamper bool

+ Test bool

+ Trouble bool

+ ZoneID *uint8

+ ZoneState uint8

+ ZoneStatus uint16

+ ZoneType zcl.IASZoneType

+ type Info struct

+ Capabilities uint16

+ Version *znp.VersionInfo

+ type InterviewOptions struct

+ RequestTimeout time.Duration

+ Retries int

+ SkipBasicCluster bool

+ func DefaultInterviewOptions() InterviewOptions

+ type InterviewResult struct

+ DeviceType DeviceType

+ Endpoints []EndpointInfo

+ Errors []string

+ IEEEAddr [8]byte

+ InterviewedAt time.Time

+ Manufacturer string

+ ManufacturerCode uint16

+ ManufacturerVersionDetails string

+ Model string

+ NwkAddr uint16

+ PowerSource PowerSource

+ ProductCode string

+ ProductLabel string

+ ProductURL string

+ SWBuildID string

+ SerialNumber string

+ Success bool

+ func (r *InterviewResult) FindEndpointWithCluster(clusterID uint16) *EndpointInfo

+ func (r *InterviewResult) IEEEAddrString() string

+ type MainsInfo struct

+ Frequency *uint8

+ Voltage *float64

+ type MultistateInputInfo struct

+ NumberOfStates uint16

+ OutOfService bool

+ PresentValue uint16

+ Reliability zcl.IOReliability

+ StatusFlags uint8

+ type MultistateOutputInfo struct

+ NumberOfStates uint16

+ OutOfService bool

+ PresentValue uint16

+ StatusFlags uint8

+ type MultistateValueInfo struct

+ NumberOfStates uint16

+ OutOfService bool

+ PresentValue uint16

+ Reliability zcl.IOReliability

+ StatusFlags uint8

+ type NeighborInfo struct

+ Depth uint8

+ DeviceType uint8

+ IEEEAddr [8]byte

+ LQI uint8

+ NwkAddr uint16

+ Relation uint8

+ type NetworkFormConfig struct

+ Channel uint8

+ PanID uint16

+ Profile string

+ type NetworkInfo struct

+ Channel uint8

+ DeviceState uint8

+ DeviceType uint8

+ ExtendedPanID [8]byte

+ IEEEAddr [8]byte

+ NumAssocDevices uint8

+ PanID uint16

+ Profiles []znp.ApplicationProfile

+ ShortAddr uint16

+ type OTAInfo struct

+ CurrentFileVersion uint32

+ FileOffset uint32

+ ImageTypeID uint16

+ ManufacturerID uint16

+ UpgradeStatus zcl.OTAUpgradeStatus

+ type Option func(*Options)

+ func WithBaudRate(rate int) Option

+ func WithPingRetries(retries int) Option

+ func WithPingTimeout(timeout time.Duration) Option

+ func WithRTSCTSFlow(enabled bool) Option

+ func WithResetTimeout(timeout time.Duration) Option

+ func WithSerialPath(path string) Option

+ type Options struct

+ PingRetries int

+ PingTimeout time.Duration

+ ResetTimeout time.Duration

+ SerialConfig serial.Config

+ func DefaultOptions() Options

+ type PollControlInfo struct

+ CheckInInterval uint32

+ FastPollTimeout uint16

+ LongPollInterval uint32

+ ShortPollInterval uint16

+ type PowerData struct

+ ActivePower *float64

+ Current *float64

+ InstantPower *float64

+ PowerFactor *int8

+ RawCurrent uint16

+ RawEnergy uint64

+ RawPower int16

+ RawVoltage uint16

+ TotalEnergy *float64

+ Voltage *float64

+ type PowerSource uint8

+ const PowerSourceBattery

+ const PowerSourceDC

+ const PowerSourceEmergencyBattery

+ const PowerSourceEmergencyMains

+ const PowerSourceMains

+ const PowerSourceUnknown

+ func (ps PowerSource) String() string

+ type PressureData struct

+ MaxPressure *float64

+ MinPressure *float64

+ Pressure *float64

+ type PriceInfo struct

+ Currency uint16

+ CurrentTime uint32

+ DurationInMinutes uint16

+ IssuerEventId uint32

+ NumberOfTiers uint8

+ Price uint32

+ PriceTrailingDigit uint8

+ ProviderId uint32

+ RateLabel string

+ StartTime uint32

+ UnitOfMeasure uint8

+ type RegisteredEndpoints struct

+ Endpoints []uint8

+ Profiles map[uint8]znp.ApplicationProfile

+ func NewRegisteredEndpoints() *RegisteredEndpoints

+ func (r *RegisteredEndpoints) Add(endpoint uint8, profile znp.ApplicationProfile)

+ func (r *RegisteredEndpoints) GetProfiles() []znp.ApplicationProfile

+ func (r *RegisteredEndpoints) HasProfile(profile znp.ApplicationProfile) bool

+ type ReportedAttribute struct

+ ID uint16

+ Value interface{}

+ type ReportingConfigResult struct

+ AttributeID zcl.AttributeID

+ DataType zcl.DataType

+ Direction uint8

+ MaxInterval uint16

+ MinInterval uint16

+ ReportableChange interface{}

+ Status uint8

+ TimeoutPeriod uint16

+ type SEMessage struct

+ Control uint8

+ Duration uint16

+ Message string

+ MessageID uint32

+ StartTime uint32

+ type SceneMembership struct

+ Capacity uint8

+ GroupID uint16

+ Scenes []uint8

+ Status uint8

+ type SensorData struct

+ Battery *uint8

+ Humidity *float32

+ Temperature *float32

+ type SensorReport struct

+ Attributes []ReportedAttribute

+ Battery *uint8

+ ClusterID uint16

+ Current *float64

+ Endpoint uint8

+ Energy *float64

+ FrameCommandID uint8

+ Humidity *float32

+ NwkAddr uint16

+ OnOff *bool

+ ParseError string

+ Power *float64

+ Temperature *float32

+ Voltage *float64

+ type ThermostatStatus struct

+ CoolingDemand *uint8

+ CoolingSetpoint *float64

+ HeatingDemand *uint8

+ HeatingSetpoint *float64

+ LocalTemperature *float64

+ RunningState *uint16

+ SystemMode *zcl.ThermostatSystemMode

+ type TimeInfo struct

+ LocalTime uint32

+ Time uint32

+ TimeStatus uint8

+ TimeZone int32

+ type WindowCoveringStatus struct

+ ConfigStatus *uint8

+ LiftPercent *uint8

+ TiltPercent *uint8

+ Type *zcl.WindowCoveringType

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL