Categorygithub.com/vkorn/go-miio
modulepackage
0.0.0-20230316082404-e59e42135268
Repository: https://github.com/vkorn/go-miio.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
17
Dependents
4
Files
1.4k SLOC

# README

go-miio

Xiaomi IoT devices protocol implementation. Mainly created for go-home.

Credits

Gateway implementation is based on xuebing1110 work.

Standalone devices are using protocol implementation by nickw444

Supported devices

Gateway-enabled

  • Temperature/humidity sensors
  • Switches
  • Motion sensors
  • Magnets
  • Gateway LED

Standalone

  • Vacuum

Protocol

Check full protocol specs here.

Full Vacuum specs are here.

# Packages

No description provided by the author
No description provided by the author

# Functions

NewGateway creates a new gateway.
NewVacuum creates a new vacuum.

# Constants

ClickDouble describes double click.
ClickLongPress describes the beginning of a long click.
ClickLongRelease describes the end of a long click.
ClickNo describes no click.
ClickSingle describes single click.
VacErrorCharge describes error with charger.
VacErrorFull describes full dust container.
VacErrorNo describes no errors.
VacErrorUnknown describes unknown error.
VacStateCharging indicates that vacuum is charging.
VacStateCleaning indicates that vacuums is cleaning.
VacStateDocking indicates that vacuum is in a process of docking.
VacStateFull indicates that dust bag is full.
VacStateInitiating indicates that vacuum is in initializing mode.
VacStatePaused indicates that cleaning is paused.
VacStateReturning indicates that vacuum is returning to the dock.
VacStateShuttingDown indicates that vacuum is shutting down.
VacStateSleeping indicates that vacuum is in a sleep mode.
VacStateSpot indicates that vacuum is cleaning a spot.
VacStateUnknown describes unknown state.
VacStateUpdating indicates that vacuum is in an update mode.
VacStateWaiting indicates that vacuum is in waiting mode.
VacStateZone indicates that vacuum is cleaning az one.

# Variables

LOGGER implementation.

# Structs

DeviceUpdateMessage contains data about an update.
Gateway represents a Xiaomi gateway.
GatewayState defines the gateway state.
Magnet defines a Xiaomi magnet.
MagnetState describes a state of the magnet.
Motion defines a Xiaomi motion sensor.
MotionState describes a state of the motion sensor.
SensorHT defines a Xiaomi humidity-temperature sensor.
SensorHTState describes a state of the humidity-temperature sensor.
Switch defines a Xiaomi switch.
SwitchState describes a state of the switch.
Vacuum defines a Xiaomi vacuum cleaner.
VacuumState describes a vacuum state.
XiaomiDevice represents Xiaomi device.

# Interfaces

IDevice defines Xiaomi device.
ILogger defines a logger interface.

# Type aliases

ClickType represents Xiaomi switch state.
VacError defines possible vacuum error.
VacState defines possible vacuum state.