Documentation ¶
Overview ¶
Package ringo provides an unofficial client to the unpublished Ring API.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct { APIVersion int Username string `mapstructure:"username"` Password string `mapstructure:"password"` Token string `json:"authentication_token"` }
Config collects a number of parameters. A nil *Config is valid but will result in the inability to connect.
type DeviceHealth ¶
type DeviceHealth struct { ID int64 `json:"id,omitempty"` WifiName string `json:"wifi_name,omitempty"` BatteryPercentage batteryLife `json:"battery_percentage,omitempty"` BatteryPercentageCategory string `json:"battery_percentage_category,omitempty"` BatteryVoltage batteryLife `json:"battery_voltage,omitempty"` BatteryVoltageCategory string `json:"battery_voltage_category,omitempty"` LatestSignalStrength int64 `json:"latest_signal_strength,omitempty"` LatestSignalCategory string `json:"latest_signal_category,omitempty"` AverageSignalStrength int64 `json:"average_signal_strength,omitempty"` AverageSignalCategory string `json:"average_signal_category,omitempty"` Firmware string `json:"firmware,omitempty"` UpdatedAt time.Time `json:"updated_at,omitempty"` WifiIsRingNetwork bool `json:"wifi_is_ring_network,omitempty"` PacketLossCategory string `json:"packet_loss_category,omitempty"` PacketLossStrength int64 `json:"packet_loss_strength,omitempty"` }
DeviceHealth contains the health of a device.
type Devices ¶
type Devices struct { Doorbots []*device `json:"doorbots,omitempty"` StickupCams []*device `json:"stickup_cams,omitempty"` }
Devices contains lists of different devices.
type Ringo ¶
Ringo is used to make requests to the unpublished Ring API.
func NewRingo ¶
NewRingo constructs a new Ringo which can make requests to the unpublished Ring API.
func (*Ringo) Authenticate ¶
Authenticate sets token based on login information.
Click to show internal directories.
Click to hide internal directories.