openhab

package

Go to main page

Versions in this module

v0

v0.10.0

Feb 14, 2024

Changes in this version

type Client

+ func (c *Client) RefreshCache() error

v0.9.0

Oct 1, 2023

Changes in this version

type Config

+ CancellationTimeout time.Duration

+ type Metric struct

+ Description string

+ Name string

+ Tags []string

+ Type MetricType

+ type MetricType int

+ const MetricTypeCounter

+ const MetricTypeGauge

type RuleData

+ Timeout time.Duration

type Telemetry

+ RegisterMetrics func(metrics []Metric)

type TelemetryLogger

+ func (t *TelemetryLogger) RegisterMetrics(metrics []Metric)

v0.8.0

Aug 27, 2023

Changes in this version

+ const MetricItemCacheHit

+ const MetricItemLoad

+ const MetricItemLoadState

+ const MetricItemName

+ const MetricItemNotFound

+ const MetricItemSetState

+ const MetricItemStateUpdated

+ const MetricItemsCacheSize

+ const MetricRuleAdded

+ const MetricRuleDeleted

+ const MetricRuleID

+ const MetricRulesCount

+ func OnStartlevel() *systemEventTrigger

type Client

+ func (c *Client) GetRulesData() []RuleData

type Config

+ Telemetry Telemetry

+ type Telemetry interface

+ AddCounter func(name string, value int64, tags map[string]string)

+ AddGauge func(name string, value int64, tags map[string]string)

+ Close func()

+ SetGauge func(name string, value int64, tags map[string]string)

+ SubGauge func(name string, value int64, tags map[string]string)

+ type TelemetryLogger struct

+ func NewTelemetryLogger(writer io.Writer) *TelemetryLogger

+ func (t *TelemetryLogger) AddCounter(name string, value int64, tags map[string]string)

+ func (t *TelemetryLogger) AddGauge(name string, value int64, tags map[string]string)

+ func (t *TelemetryLogger) Close()

+ func (t *TelemetryLogger) SetGauge(name string, value int64, tags map[string]string)

+ func (t *TelemetryLogger) SubGauge(name string, value int64, tags map[string]string)

v0.7.0

Oct 15, 2022

Changes in this version

+ var ErrRuleAlreadyActivated = errors.New("rule already activated")

+ func OnAlive() *systemEventTrigger

+ func OnThingReceivedStatusInfo(thing string, status ThingStatus) *thingReceivedStatusInfoTrigger

+ func OnThingReceivedStatusInfoChanged(thing string) *thingReceivedStatusInfoChangedTrigger

+ func OnThingReceivedStatusInfoChangedFrom(thing string, from ThingStatus) *thingReceivedStatusInfoChangedTrigger

+ func OnThingReceivedStatusInfoChangedFromTo(thing string, from, to ThingStatus) *thingReceivedStatusInfoChangedTrigger

+ func OnThingReceivedStatusInfoChangedTo(thing string, to ThingStatus) *thingReceivedStatusInfoChangedTrigger

+ type ClientState int

+ const StateConnected

+ const StateConnecting

+ const StateDisconnected

+ const StateStarting

+ type Thing struct

+ type ThingStatus string

+ const ThingStatusAny

+ const ThingStatusInitializing

+ const ThingStatusOffline

+ const ThingStatusOnline

+ const ThingStatusRemoved

+ const ThingStatusRemoving

+ const ThingStatusUninitialized

+ const ThingStatusUnknown

+ type ThingStatusDetail string

+ const ThingStatusDetailBridgeOffline

+ const ThingStatusDetailBridgeUninitialized

+ const ThingStatusDetailCommunicationError

+ const ThingStatusDetailConfigurationError

+ const ThingStatusDetailConfigurationPending

+ const ThingStatusDetailDisabled

+ const ThingStatusDetailDutyCycle

+ const ThingStatusDetailFirmwareUpdating

+ const ThingStatusDetailGone

+ const ThingStatusDetailHandlerConfigurationPending

+ const ThingStatusDetailHandlerInitializingError

+ const ThingStatusDetailHandlerMissingError

+ const ThingStatusDetailHandlerRegisteringError

+ const ThingStatusDetailNone

v0.6.0

Mar 13, 2022

Changes in this version

+ const DateTimeFormat

+ func OnDateTime(dateTime time.Time) *dateTimeTrigger

+ func OnStableConnection() *systemEventTrigger

type Client

+ func (c *Client) DeleteRule(ruleID string) int

+ func (c *Client) GetItemState(name string) (State, error)

+ func (c *Client) SendCommand(itemName string, command State) error

+ func (c *Client) SendCommandWait(itemName string, command State, timeout time.Duration) (bool, error)

+ type DateTimeState time.Time

+ func MustParseDateTimeState(value string) DateTimeState

+ func NewDateTimeState(value time.Time) DateTimeState

+ func ParseDateTimeState(value string) (DateTimeState, error)

+ func (s DateTimeState) Equal(other string) bool

+ func (s DateTimeState) Raw() interface{}

+ func (s DateTimeState) String() string

+ func (s DateTimeState) Time() time.Time

type DecimalState

+ func (s DecimalState) Equal(other string) bool

+ func (s DecimalState) Raw() interface{}

type RuleClient

+ DeleteRule func(ruleID string) int

+ GetItemState func(name string) (State, error)

+ SendCommand func(itemName string, command State) error

+ SendCommandWait func(itemName string, command State, timeout time.Duration) (bool, error)

+ type State interface

+ Equal func(other string) bool

+ Raw func() interface{}

+ String func() string

type StringState

+ func (s StringState) Equal(other string) bool

+ func (s StringState) Raw() interface{}

type SwitchState

+ func (s SwitchState) Equal(other string) bool

+ func (s SwitchState) Raw() interface{}

v0.5.0

Mar 5, 2022

v0.4.0

Nov 23, 2021

Changes in this version

type DecimalState

+ func (s DecimalState) Float64() float64

+ func (s DecimalState) Unit() string

v0.3.0

Nov 22, 2021

Changes in this version

+ func OnError() *systemEventTrigger

type RuleClient

+ AddRule func(ruleData RuleData, run Runner, triggers ...Trigger) (ruleID string)

v0.2.0

Nov 21, 2021

Changes in this version

type Client

+ func (c *Client) GetItem(name string) (*Item, error)

+ func (c *Client) GetMembersOf(groupName string) ([]*Item, error)

+ type RuleClient interface

+ GetItem func(name string) (*Item, error)

+ GetMembersOf func(groupName string) ([]*Item, error)

+ Stop func()

v0.1.0

Nov 20, 2021

Changes in this version

+ const StateNULL

+ const StateOFF

+ const StateON

+ var ErrorNotFound = errors.New("not found")

+ func SetDebugLog(logger Logger)

+ func SetErrorLog(logger Logger)

+ type Client struct

+ func NewClient(config Config) *Client

+ func (c *Client) AddRule(ruleData RuleData, run Runner, triggers ...Trigger) *Client

+ func (c *Client) Items() *Items

+ func (c *Client) Start()

+ func (c *Client) Stop()

+ type Config struct

+ APIToken string

+ BasicAuthentication bool

+ Client *http.Client

+ Password string

+ ReconnectionInitialBackoff time.Duration

+ ReconnectionJitter float64

+ ReconnectionMaxBackoff time.Duration

+ ReconnectionMultiplier float64

+ StableConnectionDuration time.Duration

+ TimeoutHTTP time.Duration

+ URL string

+ User string

+ type DecimalState float64

+ func MustParseDecimalState(value string) DecimalState

+ func NewDecimalState(value float64) DecimalState

+ func ParseDecimalState(value string) (DecimalState, error)

+ func (s DecimalState) String() string

+ type Item struct

+ func (i *Item) IsGroup() bool

+ func (i *Item) IsMemberOf(groupName string) bool

+ func (i *Item) Name() string

+ func (i *Item) SendCommand(command StateValue) error

+ func (i *Item) SendCommandWait(command StateValue, timeout time.Duration) (bool, error)

+ func (i *Item) State() (StateValue, error)

+ func (i *Item) Type() ItemType

+ func (i *Item) Updated() time.Time

+ type ItemReceivedCommandTrigger struct

+ func OnItemReceivedCommand(item string, state StateValue) *ItemReceivedCommandTrigger

+ type ItemReceivedStateTrigger struct

+ func OnItemReceivedState(item string, state StateValue) *ItemReceivedStateTrigger

+ type ItemStateChangedTrigger struct

+ func OnItemStateChanged(item string) *ItemStateChangedTrigger

+ func OnItemStateChangedFrom(item string, from StateValue) *ItemStateChangedTrigger

+ func OnItemStateChangedFromTo(item string, from, to StateValue) *ItemStateChangedTrigger

+ func OnItemStateChangedTo(item string, to StateValue) *ItemStateChangedTrigger

+ type ItemType string

+ const ItemTypeColor

+ const ItemTypeContact

+ const ItemTypeDateTime

+ const ItemTypeDimmer

+ const ItemTypeGroup

+ const ItemTypeImage

+ const ItemTypeLocation

+ const ItemTypeNumber

+ const ItemTypeRollershutter

+ const ItemTypeString

+ const ItemTypeSwitch

+ const ItemTypeUnknown

+ type Items struct

+ func (items *Items) GetItem(name string) (*Item, error)

+ func (items *Items) GetMembersOf(groupName string) ([]*Item, error)

+ type Logger interface

+ Printf func(format string, v ...interface{})

+ type Rule struct

+ func (r *Rule) String() string

+ type RuleData struct

+ Context interface{}

+ Description string

+ ID string

+ Name string

+ type Runner func(client *Client, ruleData RuleData, e event.Event)

+ type StateValue interface

+ String func() string

+ type StringState string

+ func (s StringState) String() string

+ type SwitchState string

+ const SwitchOFF

+ const SwitchON

+ func (s SwitchState) String() string

+ type SystemEventTrigger struct

+ func OnConnect() *SystemEventTrigger

+ func OnDisconnect() *SystemEventTrigger

+ func OnStart() *SystemEventTrigger

+ func OnStop() *SystemEventTrigger

+ type TimeCronTrigger struct

+ func OnTimeCron(spec string) *TimeCronTrigger

+ type Trigger interface

+ type TriggerDebounce struct

+ func Debounce(trigger Trigger, after time.Duration) *TriggerDebounce

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