redlink 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/Readme.markdown +39 -0
- data/lib/redlink/cli.rb +1 -11
- data/lib/redlink/version.rb +1 -1
- metadata +1 -1
data/Readme.markdown
CHANGED
@@ -1 +1,40 @@
|
|
1
1
|
# Redlink
|
2
|
+
|
3
|
+
A gem for controlling Honeywell Redlink-based home heating and cooling products.
|
4
|
+
|
5
|
+
# Status
|
6
|
+
|
7
|
+
Basic location & thermostat discovery functional. Ability to refresh thermostat data functional. Super alpha quality code.
|
8
|
+
|
9
|
+
# Prerequisites
|
10
|
+
|
11
|
+
* A valid Redlink App ID. You'll have to find one on your own.
|
12
|
+
* A valid login at https://rs.alarmnet.com/TotalConnectComfort/.
|
13
|
+
|
14
|
+
# Getting Started
|
15
|
+
|
16
|
+
1. Clone the gem with `gem install redlink`.
|
17
|
+
2. Initialize your environment with the app id via `redlink init 9RS79360-PO1R-4P6S-O20S-7N5Q37N028PO`. _(Note: not a real app id)_
|
18
|
+
3. Provide credentials to the environment via `redlink login username@host.com password`.
|
19
|
+
|
20
|
+
# Usage
|
21
|
+
|
22
|
+
Redlink provides a basic CLI experience as well as a growing set of APIs for actual manipulation.
|
23
|
+
|
24
|
+
`relink locations` returns a list of locations and thermostats connected to your account.
|
25
|
+
|
26
|
+
# TODO
|
27
|
+
|
28
|
+
* Documentation
|
29
|
+
* Testing
|
30
|
+
* Ability to set thermostats
|
31
|
+
* Ability to alter schedules
|
32
|
+
* Vacation mode
|
33
|
+
|
34
|
+
## Contributing
|
35
|
+
|
36
|
+
1. Fork it
|
37
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
38
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
39
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
40
|
+
5. Create new Pull Request
|
data/lib/redlink/cli.rb
CHANGED
@@ -14,7 +14,7 @@ module Redlink
|
|
14
14
|
Redlink::Endpoint.login(username, password)
|
15
15
|
end
|
16
16
|
|
17
|
-
desc 'logout', '
|
17
|
+
desc 'logout', 'Log the active user out'
|
18
18
|
def logout
|
19
19
|
Redlink::Endpoint.logout
|
20
20
|
end
|
@@ -36,15 +36,5 @@ module Redlink
|
|
36
36
|
end
|
37
37
|
end
|
38
38
|
|
39
|
-
desc 'operations', 'wfasd'
|
40
|
-
def operations
|
41
|
-
p Redlink::Endpoint.endpoint_client.operations
|
42
|
-
end
|
43
|
-
|
44
|
-
desc 'session_id SESSION_ID', 'blah'
|
45
|
-
def session_id(session_id)
|
46
|
-
Redlink::Configuration.session_id = session_id
|
47
|
-
end
|
48
|
-
|
49
39
|
end
|
50
40
|
end
|
data/lib/redlink/version.rb
CHANGED