types

package
v0.7.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 2, 2025 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DurationString added in v0.7.1

type DurationString string

DurationString represents a duration, such as "2s" or "24h". See https://pkg.go.dev/time#ParseDuration for all valid time units.

type EventZWaveJSValueNotification added in v0.7.1

type EventZWaveJSValueNotification struct {
	ID    int    `json:"id"`
	Type  string `json:"type"`
	Event struct {
		EventType string `json:"event_type"`
		Data      struct {
			Domain           string `json:"domain"`
			NodeID           int    `json:"node_id"`
			HomeID           int64  `json:"home_id"`
			Endpoint         int    `json:"endpoint"`
			DeviceID         string `json:"device_id"`
			CommandClass     int    `json:"command_class"`
			CommandClassName string `json:"command_class_name"`
			Label            string `json:"label"`
			Property         string `json:"property"`
			PropertyName     string `json:"property_name"`
			PropertyKey      string `json:"property_key"`
			PropertyKeyName  string `json:"property_key_name"`
			Value            string `json:"value"`
			ValueRaw         int    `json:"value_raw"`
		} `json:"data"`
		Origin    string    `json:"origin"`
		TimeFired time.Time `json:"time_fired"`
	} `json:"event"`
}

type Item added in v0.7.1

type Item struct {
	Value    interface{}
	Priority float64
}

Item represents a priority queue item with a value and priority.

type NewAppRequest added in v0.7.1

type NewAppRequest struct {
	// Required
	URL string

	// Optional
	// Deprecated: use URL instead
	// IpAddress of your Home Assistant instance i.e. "localhost"
	// or "192.168.86.59" etc.
	IpAddress string

	// Optional
	// Deprecated: use URL instead
	// Port number Home Assistant is running on. Defaults to 8123.
	Port string

	// Required
	// Auth token generated in Home Assistant. Used
	// to connect to the Websocket API.
	HAAuthToken string

	// Required
	// EntityId of the zone representing your home e.g. "zone.home".
	// Used to pull latitude/longitude from Home Assistant
	// to calculate sunset/sunrise times.
	HomeZoneEntityId string

	// Optional
	// Whether to use secure connections for http and websockets.
	// Setting this to `true` will use `https://` instead of `https://`
	// and `wss://` instead of `ws://`.
	Secure bool
}

NewAppRequest contains the configuration for creating a new App instance.

type NotifyRequest

type NotifyRequest struct {
	// Which notify service to call, such as mobile_app_sams_iphone
	ServiceName string
	Message     string
	Title       string
	Data        map[string]any
}

type SetTemperatureRequest

type SetTemperatureRequest struct {
	Temperature    float32
	TargetTempHigh float32
	TargetTempLow  float32
	HvacMode       string
}

func (*SetTemperatureRequest) ToJSON

func (r *SetTemperatureRequest) ToJSON() map[string]any

type TimeRange added in v0.7.1

type TimeRange struct {
	Start time.Time
	End   time.Time
}

TimeRange represents a time range with start and end times.

type TimeString added in v0.7.1

type TimeString string

TimeString is a 24-hr format time "HH:MM" such as "07:30".

Jump to

Keyboard shortcuts

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