Download in unofficial_sense_api - unofficial_sense

unofficial_sense_api

PowerBuilder

1.0.0

Herunterladen

Inoffizieller Sinn API

Greifen Sie auf Ihre Sinnesdaten zu.

Installation

Fügen Sie diese Zeile der GemFile Ihrer Anwendung hinzu:

 gem 'unofficial_sense_api'

Und dann ausführen:

 $ bundle

Oder installieren Sie es selbst als:

 $ gem install unofficial_sense_api

Verwendung

Erhalten von Echtzeitdaten (startet ein WebSocket an wss://clientrt.sense.com/monitors/#{api.first_monitor_id}/realtimefeed )

 require 'sense_api'
require 'pp'

api = SenseApi . new ( "USERNAME" , "PASSWORD" )

count = 0
api . realtime do | json |
  pp json

  # Be sure to return :exit to terminate the connection and shut down EventMachine!
  count += 1
  count > 5 ? :exit : nil
end

Verwenden Sie fetch , um von REST -Endpunkten Ihrer Wahl zu ziehen. In diesem Juwel wurde noch keiner hinzugefügt.

 require 'sense_api'
api = SenseApi . new ( "USERNAME" , "PASSWORD" )

timeline = api . fetch ( "https://api.sense.com/apiservice/api/v1/users/ #{ api . user_id } /timeline?n_item=30" )

trends = api . fetch ( "https://api.sense.com/apiservice/api/v1/app/history/trends?monitor_id= #{ api . first_monitor_id } &scale=WEEK&start=2017-10-23T04:00:00.000Z" )

devices = api . fetch ( "https://api.sense.com/apiservice/api/v1/app/monitors/ #{ api . first_monitor_id } /devices?include_merged=true" )

first_device_id = devices . first [ "id" ]

first_device_details = api . fetch ( "https://api.sense.com/apiservice/api/v1/app/monitors/ #{ api . first_monitor_id } /devices/ #{ first_device_id } " )
first_device_hostory = api . fetch ( "https://api.sense.com/apiservice/api/v1/app/history/usage?monitor_id= #{ api . first_monitor_id } &granularity=MINUTE&start=2017-10-21T11:00:00.000Z&frames=5400&device_id= #{ first_device_id } " )

Hier sind die Endpunkte, über die wir bisher wissen:

"https://api.sense.com/apiservice/api/v1/users/#{api.user_id}/timeline?n_item=30"
"https://api.sense.com/apiservice/api/v1/app/history/trends?monitor_id=#{api.first_monitor_id}&scale=WEEK&start=2017-10-23T04:00:00.000Z"
"https://api.sense.com/apiservice/api/v1/app/history/usage?monitor_id=#{api.first_monitor_id}&granularity=SECOND&start=2017-10-25T03:54:00.000Z&frames=5400" {api.first_monitor_id}& granularity =second& SECOND MINUTE 2017-10-25T03:54:00.000z&frames=5400"

Listengeräte:

"https://api.sense.com/apiservice/api/v1/app/monitors/#{api.first_monitor_id}/devices?include_merged=true"

Sie können der Verlaufsanforderung eine device_id hinzufügen:

"https://api.sense.com/apiservice/api/v1/app/history/usage?monitor_id=#{api.first_monitor_id}&granularity=MINUTE&start=2017-10-21T11:00:00.000Z&frames=5400&device_id=SOME_DEVICE_ID"

Und holen Sie sich die Daten für Geräte:

"https://api.sense.com/apiservice/api/v1/app/monitors/#{api.first_monitor_id}/devices/always_on"
"https://api.sense.com/apiservice/api/v1/app/monitors/#{api.first_monitor_id}/devices/unknown"
"https://api.sense.com/apiservice/api/v1/app/monitors/#{api.first_monitor_id}/devices/SOME_DEVICE_ID"

Zugriff auf die API mit Locken

Wenn Sie möchten, können Sie Ruby vollständig überspringen und mit der Sense -API mit Curl sprechen:

curl -k --data "[email protected]" --data "password=URL_ENCODED_PASSWORD" -H "Sense-Client-Version: 1.17.1-20c25f9" -H "X-Sense-Protocol: 3" -H "User-Agent: okhttp/3.8.0" "https://api.sense.com/apiservice/api/v1/authenticate"

Die Antwort hat einen access_token sowie ein user_id und ein monitors -Array, mit dem Sie auf die Sense -APIs zugreifen können. Zum Beispiel:

curl -k -H "Authorization: bearer ACCESS_TOKEN" -H "Sense-Client-Version: 1.17.1-20c25f9" -H "X-Sense-Protocol: 3" -H "User-Agent: okhttp/3.8.0" "https://api.sense.com/apiservice/api/v1/app/history/usage?monitor_id=A_MONITOR_ID&granularity=SECOND&start=2017-10-24T05:36:00.000Z&frames=5400"

Entwicklung

Sie können bin/console für eine interaktive Eingabeaufforderung ausführen, mit der Sie experimentieren können.

Um dieses Juwel auf Ihrem lokalen Computer zu installieren, führen Sie bundle exec rake install aus. Um eine neue Version zu veröffentlichen, aktualisieren Sie die Versionsnummer in version.rb und führen Sie bundle exec rake release aus, die ein Git -Tag für die Version erstellt, Git Commits und Tags drücken und die .gem -Datei auf rubygemems.org weitergeben.