switchbot

package module

Go to main page

Versions in this module

v1

v1.0.0

Nov 11, 2022

Changes in this version

+ type CeilingEvent struct

+ Context CeilingEventContext

+ EventType string

+ EventVersion string

+ type CeilingEventContext struct

+ Brightness int

+ ColorTemperature int

+ DeviceMac string

+ DeviceType string

+ PowerState PowerState

+ TimeOfSample int64

+ type CleanerOnlineStatus string

+ const CleanerOffline

+ const CleanerOnline

+ type CleanerWorkingStatus string

+ const CleanerChargeDone

+ const CleanerCharging

+ const CleanerClearing

+ const CleanerDormant

+ const CleanerGotoChargeBase

+ const CleanerInDustCollecting

+ const CleanerInRemoteControl

+ const CleanerInTrouble

+ const CleanerPaused

+ const CleanerStandBy

type Command

+ func ACSetAllCommand(temperature int, mode ACMode, fanSpeed ACFanSpeed, power PowerState) Command

+ func ButtonPushCommand(name string) Command

+ func ChannelAddCommand() Command

+ func ChannelSubCommand() Command

+ func CreateKeyCommand(name string, typ PasscodeType, password string, start, end time.Time) (Command, error)

+ func DeleteKeyCommand(id int) Command

+ func DockCommand() Command

+ func FanHighSpeedCommand() Command

+ func FanLowSpeedCommand() Command

+ func FanMiddleSpeedCommand() Command

+ func FanSwingCommand() Command

+ func FanTimerCommand() Command

+ func FastForwardCommand() Command

+ func LightBrightnessDownCommand() Command

+ func LightBrightnessUpCommand() Command

+ func LockCommand() Command

+ func NextCommand() Command

+ func PauseCommand() Command

+ func PlayCommand() Command

+ func PowLevelCommand(level VacuumPowerLevel) Command

+ func PressCommand() Command

+ func PreviousCommand() Command

+ func RewindCommand() Command

+ func SetAllStatusCommand(power PowerState, fanMode SmartFanMode, fanSpeed, shakeRange int) Command

+ func SetBrightnessCommand(brightness int) Command

+ func SetChannelCommand(channelNumber int) Command

+ func SetColorCommand(r, g, b int) Command

+ func SetColorTemperatureCommand(temperature int) Command

+ func SetModeCommand(mode HumidifierMode) Command

+ func SetMuteCommand() Command

+ func StartCommand() Command

+ func StopCommand() Command

+ func StopPlayerCommand() Command

+ func ToggleCommand() Command

+ func TurnOffCommand() Command

+ func TurnOnCommand() Command

+ func UnlockCommand() Command

+ func VolumeAddCommand() Command

+ func VolumeSubCommand() Command

type Device

+ GroupName bool

+ KeyList []KeyListItem

+ LockDeviceID string

+ LockDeviceIDs []string

type DeviceStatus

+ IsLackWater bool

+ IsMoveDetected bool

+ type KeyListItem struct

+ CreateTime int64

+ ID int

+ IV string

+ Name string

+ Password string

+ Status PasscodeStatus

+ Type PasscodeType

+ type KeypadEvent struct

+ Context KeypadEventContext

+ EventType string

+ EventVersion string

+ type KeypadEventContext struct

+ CommandID string

+ DeviceMac string

+ DeviceType string

+ EventName string

+ Result string

+ TimeOfSample int64

+ type PasscodeStatus string

+ const PasscodeStatusValid

+ const PasscodeStautsInvalid

+ type PasscodeType string

+ const DisposablePasscode

+ const PermanentPasscode

+ const TimeLimitPasscode

+ const UrgentPasscode

type PhysicalDeviceType

+ const CeilingLight

+ const CeilingLightPro

+ const IndoorCam

+ const KeyPad

+ const KeyPadTouch

+ const PanTiltCam

+ const PanTiltCam2K

+ type SweeperEvent struct

+ Context SweeperEventContext

+ EventType string

+ EventVersion string

+ type SweeperEventContext struct

+ Battery int

+ DeviceMac string

+ DeviceType string

+ OnlineStatus CleanerOnlineStatus

+ TimeOfSample int64

+ WorkingStatus CleanerWorkingStatus

v0

v0.3.0

Nov 5, 2022

Changes in this version

+ func ParseWebhookRequest(r *http.Request) (interface{}, error)

type Client

+ func (c *Client) Webhook() *WebhookService

+ type ColorBulbEvent struct

+ Context ColorBulbEventContext

+ EventType string

+ EventVersion string

+ type ColorBulbEventContext struct

+ Brightness int

+ Color string

+ ColorTemperature int

+ DeviceMac string

+ DeviceType string

+ PowerState string

+ TimeOfSample int64

type Command

+ func Dock() Command

+ func PowLevel(level VacuumPowerLevel) Command

+ func SetAllStatus(power PowerState, fanMode SmartFanMode, fanSpeed, shakeRange int) Command

+ func SetBrightness(brightness int) Command

+ func SetColor(r, g, b int) Command

+ func SetColorTemperature(temperature int) Command

+ func Start() Command

+ func Stop() Command

+ func Toggle() Command

+ type ContactSensorEvent struct

+ Context ContactSensorEventContext

+ EventType string

+ EventVersion string

+ type ContactSensorEventContext struct

+ Brightness string

+ DetectionState string

+ DeviceMac string

+ DeviceType string

+ DoorMode string

+ OpenState string

+ TimeOfSample int64

type DeviceStatus

+ Battery int

+ DoorState string

+ ElectricCurrent int

+ ElectricityOfDay int

+ LockState string

+ OnlineStatus string

+ Voltage int

+ Weight int

+ WorkingStatus string

+ type IndoorCamEvent struct

+ Context IndoorCamEventContext

+ EventType string

+ EventVersion string

+ type IndoorCamEventContext struct

+ DetectionState string

+ DeviceMac string

+ DeviceType string

+ TimeOfSample int64

+ type LockEvent struct

+ Context LockEventContext

+ EventType string

+ EventVersion string

+ type LockEventContext struct

+ DeviceMac string

+ DeviceType string

+ LockState string

+ TimeOfSample int64

+ type MeterEvent struct

+ Context MeterEventContext

+ EventType string

+ EventVersion string

+ type MeterEventContext struct

+ DeviceMac string

+ DeviceType string

+ Humidity int

+ Scale string

+ Temperature float64

+ TimeOfSample int64

+ type MeterPlusEvent struct

+ Context MeterPlusEventContext

+ EventType string

+ EventVersion string

+ type MeterPlusEventContext struct

+ DeviceMac string

+ DeviceType string

+ Humidity int

+ Scale string

+ Temperature float64

+ TimeOfSample int64

+ type MotionSensorEvent struct

+ Context MotionSensorEventContext

+ EventType string

+ EventVersion string

+ type MotionSensorEventContext struct

+ DetectionState string

+ DeviceMac string

+ DeviceType string

+ TimeOfSample int64

+ type PanTiltCamEvent struct

+ Context PanTiltCamEventContext

+ EventType string

+ EventVersion string

+ type PanTiltCamEventContext struct

+ DetectionState string

+ DeviceMac string

+ DeviceType string

+ TimeOfSample int64

type PhysicalDeviceType

+ const Lock

+ const MeterPlus

+ const MeterPlusJP

+ const MeterPlusUS

+ const PlugMiniJP

+ const PlugMiniUS

+ const RobotVacuumCleanerS1

+ const RobotVacuumCleanerS1Plus

+ const StripLight

+ type PlugMiniJPEvent struct

+ Context PlugMiniJPEventContext

+ EventType string

+ EventVersion string

+ type PlugMiniJPEventContext struct

+ DeviceMac string

+ DeviceType string

+ PowerState string

+ TimeOfSample int64

+ type PlugMiniUSEvent struct

+ Context PlugMiniUSEventContext

+ EventType string

+ EventVersion string

+ type PlugMiniUSEventContext struct

+ DeviceMac string

+ DeviceType string

+ PowerState string

+ TimeOfSample int64

+ type SmartFanMode int

+ const NaturalFanMode

+ const StandardFanMode

+ type StripLightEvent struct

+ Context StripLightEventContext

+ EventType string

+ EventVersion string

+ type StripLightEventContext struct

+ Brightness int

+ Color string

+ DeviceMac string

+ DeviceType string

+ PowerState string

+ TimeOfSample int64

+ type VacuumPowerLevel int

+ const MaxVacuumPowerLevel

+ const QuietVacuumPowerLevel

+ const StandardVacuumPowerLevel

+ const StrongVacuumPowerLevel

+ type WebhookQueryActionType string

+ const QueryDetails

+ const QueryURL

+ type WebhookService struct

+ func (svc *WebhookService) Delete(ctx context.Context, url string) error

+ func (svc *WebhookService) Query(ctx context.Context, action WebhookQueryActionType, url string) error

+ func (svc *WebhookService) Setup(ctx context.Context, url, deviceList string) error

+ func (svc *WebhookService) Update(ctx context.Context, url string, enable bool) error

v0.2.0

Sep 14, 2021

Changes in this version

+ type AmbientBrightness string

+ const AmbientBrightnessBright

+ const AmbientBrightnessDim

+ type BrightnessState struct

+ func (brightness *BrightnessState) UnmarshalJSON(b []byte) error

+ func (brightness BrightnessState) AmbientBrightness() (AmbientBrightness, error)

+ func (brightness BrightnessState) Int() (int, error)

type Command

+ func FanHighSpeed() Command

+ func FanLowSpeed() Command

+ func FanMiddleSpeed() Command

+ func FanSwing() Command

+ func FanTimer() Command

+ Request func() DeviceCommandRequest

+ type DeviceCommandRequest struct

+ Command string

+ CommandType string

+ Parameter string

+ func (req DeviceCommandRequest) Request() DeviceCommandRequest

type DeviceStatus

+ Brightness BrightnessState

+ Color string

+ ColorTemperature int

+ LackWater bool

+ MoveDetected bool

+ OpenState OpenState

+ type OpenState string

+ const ContactClose

+ const ContactOpen

+ const ContactTimeoutNotClose

type PhysicalDeviceType

+ const ColorBulb

+ const ContactSensor

+ const MotionSensor

v0.1.0

Mar 29, 2021

Changes in this version

+ const DefaultEndpoint

+ type ACFanSpeed int

+ const ACAutoSpeed

+ const ACHigh

+ const ACLow

+ const ACMedium

+ type ACMode int

+ const ACAuto

+ const ACCool

+ const ACDry

+ const ACFan

+ const ACHeat

+ type Client struct

+ func New(openToken string, opts ...Option) *Client

+ func (c *Client) Device() *DeviceService

+ func (c *Client) Scene() *SceneService

+ type Command interface

+ func ACSetAll(temperature int, mode ACMode, fanSpeed ACFanSpeed, power PowerState) Command

+ func ButtonPush(name string) Command

+ func Press() Command

+ func SetMode(mode HumidifierMode) Command

+ func SetPosition(index int, mode SetPositionMode, position int) Command

+ func TurnOff() Command

+ func TurnOn() Command

+ type Device struct

+ Curtains []string

+ Hub string

+ ID string

+ IsCalibrated bool

+ IsEnableCloudService bool

+ IsGrouped bool

+ IsMaster bool

+ Name string

+ OpenDirection string

+ Type PhysicalDeviceType

+ type DeviceService struct

+ func (svc *DeviceService) Command(ctx context.Context, id string, cmd Command) error

+ func (svc *DeviceService) List(ctx context.Context) ([]Device, []InfraredDevice, error)

+ func (svc *DeviceService) Status(ctx context.Context, id string) (DeviceStatus, error)

+ type DeviceStatus struct

+ FanMode int

+ FanSpeed int

+ Hub string

+ Humidity int

+ ID string

+ IsAuto bool

+ IsCalibrated bool

+ IsChildLock bool

+ IsGrouped bool

+ IsMoving bool

+ IsShaking bool

+ IsSound bool

+ NebulizationEfficiency int

+ Power PowerState

+ ShakeCenter int

+ ShakeRange int

+ SlidePosition int

+ Temperature float64

+ Type PhysicalDeviceType

+ type HumidifierMode int

+ const AutoMode

+ const HighMode

+ const LowMode

+ const MidMode

+ type InfraredDevice struct

+ Hub string

+ ID string

+ Name string

+ Type VirtualDeviceType

+ type Option func(*Client)

+ func WithEndpoint(endpoint string) Option

+ func WithHTTPClient(httpClient *http.Client) Option

+ type PhysicalDeviceType string

+ const Bot

+ const Curtain

+ const Hub

+ const HubMini

+ const HubPlus

+ const Humidifier

+ const Meter

+ const Plug

+ const SmartFan

+ type PowerState string

+ const PowerOff

+ const PowerOn

+ func (power PowerState) ToLower() string

+ type Scene struct

+ ID string

+ Name string

+ type SceneService struct

+ func (svc *SceneService) Execute(ctx context.Context, id string) error

+ func (svc *SceneService) List(ctx context.Context) ([]Scene, error)

+ type SetPositionMode int

+ const DefaultMode

+ const PerformanceMode

+ const SilentMode

+ type VirtualDeviceType string

+ const AirConditioner

+ const AirPurifier

+ const Camera

+ const DVD

+ const Fan

+ const IPTVStreamer

+ const Light

+ const Others

+ const Projector

+ const SetTopBox

+ const Speaker

+ const TV

+ const VacuumCleaner

+ const WaterHeater

Other modules containing this package

github.com/nasa9084/go-switchbot/v2

github.com/nasa9084/go-switchbot/v3

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