Skip to content

An unofficial Ruby client for the unofficial Whistle v3 API, unofficially

License

Notifications You must be signed in to change notification settings

benbalter/whistle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Whistle

Build Status

An unofficial Ruby client for the unofficial Whistle v3 API, unofficially

Based on the Whistle pet tracker API as documented in https://community.home-assistant.io/t/whistle-v3-api/89538.

Usage

require 'whistle'

client = Whistle::Client.new(
  email: 'EMAIL',
  password: 'PASSWORD',
  pet_id: 'PET_ID'
)

# If the WHISTLE_EMAIL, WHISTLE_PASSWORD, and WHISTLE_PET_ID env vars are set
client = Whistle::Client.new

client.pet
=> "#<Whistle::Pet>"

client.pet.name
=> "Fido"

client.pet.current_minutes_active
=> 45

client.pet.timeline
=> [Whistle::TimelineEntry]

client.pet.current_location
=> Whistle::TimelineEntry

client.pet.time_inside(humanize: true)
=> "five minutes"

About

An unofficial Ruby client for the unofficial Whistle v3 API, unofficially

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published