sensi 0.0.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.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 8513ea61fbd01b718be71e456d6b0b66e14260de
4
+ data.tar.gz: fdcda5020fa01edd11c80a25744543041c98c1a5
5
+ SHA512:
6
+ metadata.gz: 782a44058da5eb06d122fbddcb2df0bddc095ecd6d519993c02309ceb858c51a0df196cb85f9758ff6aa179aa13b3f6e83e2b8194cfc93022872877a36c5a17f
7
+ data.tar.gz: 8d199cd19a6ee06e405ae3331ba7ae04fd57b0315154084150a8c55ae24124758c2537e444e5de311d47ae82c0feb7b457d0cddb7105db6b613a3ebd2c65b74a
data/.gitignore ADDED
@@ -0,0 +1,4 @@
1
+ lib/inital_response.json
2
+ .DS_STORE
3
+ sensi.sublime-project
4
+ sensi.sublime-workspace
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6
+
7
+ Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in sensi.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,340 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Lesser General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ {description}
294
+ Copyright (C) {year} {fullname}
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License along
307
+ with this program; if not, write to the Free Software Foundation, Inc.,
308
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309
+
310
+ Also add information on how to contact you by electronic and paper mail.
311
+
312
+ If the program is interactive, make it output a short notice like this
313
+ when it starts in an interactive mode:
314
+
315
+ Gnomovision version 69, Copyright (C) year name of author
316
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317
+ This is free software, and you are welcome to redistribute it
318
+ under certain conditions; type `show c' for details.
319
+
320
+ The hypothetical commands `show w' and `show c' should show the appropriate
321
+ parts of the General Public License. Of course, the commands you use may
322
+ be called something other than `show w' and `show c'; they could even be
323
+ mouse-clicks or menu items--whatever suits your program.
324
+
325
+ You should also get your employer (if you work as a programmer) or your
326
+ school, if any, to sign a "copyright disclaimer" for the program, if
327
+ necessary. Here is a sample; alter the names:
328
+
329
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
331
+
332
+ {signature of Ty Coon}, 1 April 1989
333
+ Ty Coon, President of Vice
334
+
335
+ This General Public License does not permit incorporating your program into
336
+ proprietary programs. If your program is a subroutine library, you may
337
+ consider it more useful to permit linking proprietary applications with the
338
+ library. If this is what you want to do, use the GNU Lesser General
339
+ Public License instead of this License.
340
+
data/README.md ADDED
@@ -0,0 +1,135 @@
1
+ # Sensi
2
+ API Wrapper for Emersion Sensi WiFi Thermostats.
3
+
4
+ **This gem is currently in development. Expect API breaking changes on each release. **
5
+
6
+ ## Installation
7
+
8
+ Add this line to your application's Gemfile:
9
+
10
+ ```ruby
11
+ gem 'sensi'
12
+ ```
13
+
14
+ And then execute:
15
+
16
+ $ bundle install
17
+
18
+ Or install it yourself as:
19
+
20
+ $ gem install sensi
21
+
22
+ ## Usage
23
+
24
+ Connect to a thermostat with the device's email and password.
25
+ ```ruby
26
+ >thermostat = Sensi::Thermostat.new('joe@example.com', 'joespassword')
27
+ >thermostat.connect
28
+ ```
29
+ Get system information
30
+ ```ruby
31
+ >thermostat.system_modes
32
+ =>["Heat","Cool","Off","Aux","Auto"]
33
+ ```
34
+
35
+
36
+ Get system settings; what should the HVAC do?
37
+ ```ruby
38
+ >thermostat.system_mode
39
+ =>"Heat"
40
+ >thermostat.system_temperature :heat
41
+ =>71
42
+ >thermostat.system_temperature :cool
43
+ =>77
44
+
45
+ # general check if system is on or off
46
+ >thermostat.system_on?
47
+ =>true
48
+ >thermostat.system_off?
49
+ =>false
50
+
51
+ # convenience methods for system mode checks, only one of these should be true at a time
52
+ >thermostat.system_heat_on?
53
+ =>true
54
+ >thermostat.system_cool_on?
55
+ =>false
56
+ >thermostat.system_aux_on?
57
+ =>false
58
+ >thermostat.system_auto_on?
59
+
60
+ # system fan
61
+ >thermostat.system_fan_on?
62
+ =>true
63
+ ```
64
+
65
+ Get system state; what is the HVAC doing now?
66
+ ```ruby
67
+ >thermostat.active?
68
+ =>true
69
+ >thermostat.active_mode
70
+ =>"Heat"
71
+ >thermostat.active_time
72
+ =>"00:04:27" # hh:mm:ss
73
+
74
+ >thermostat.temperature
75
+ =>71
76
+ >thermostat.temperature(:C)
77
+ =>21
78
+ thermostat.humidity
79
+ =>51
80
+
81
+
82
+
83
+ ```
84
+
85
+ Adjust settings
86
+ ```ruby
87
+ # turn heat on and set to 70F
88
+ >thermostat.set(mode: :heat, temp: 70)
89
+ =>true
90
+
91
+ # set system to cool
92
+ >thermostat.set(mode: :cool, temp: 77)
93
+ =>true
94
+
95
+ # temperature scale defaults to Fahrenheit, pass the scale argument :C for Celius.
96
+ >thermostat.set(mode: cool, temp: 22, scale: :C)
97
+ =>true
98
+
99
+ # turn the fan on
100
+ >thermostat.set(fan: :on)
101
+ =>true
102
+
103
+ # turn fan off
104
+ >thermostat.set(fan: :auto)
105
+ =>true
106
+ ```
107
+
108
+ Disconnect when you're done.
109
+
110
+ ```ruby
111
+ thermostat.disconnect
112
+ ```
113
+
114
+ ## To Do
115
+ * Documentation
116
+ * View/Modify Schedules
117
+
118
+ ## Development
119
+
120
+ After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
121
+
122
+ To install this gem onto your local machine, run `bundle exec rake install`.
123
+
124
+ ## Contributing
125
+
126
+ Bug reports and pull requests are welcome on GitHub at https://github.com/kirbs-/sensi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
127
+
128
+
129
+ ## License
130
+
131
+ The gem is available as open source under the terms of the GNU General Public License v2.0.
132
+
133
+
134
+
135
+
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "sensi"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
data/lib/sensi.rb ADDED
@@ -0,0 +1,16 @@
1
+ require "sensi/version"
2
+ require 'httparty'
3
+ require 'curb'
4
+ require 'json'
5
+
6
+ require 'sensi/account'
7
+ require 'sensi/thermostat_connection'
8
+ require 'sensi/thermostat'
9
+ require 'sensi/utils'
10
+
11
+
12
+ module Sensi
13
+
14
+ API_URI = 'https://bus-serv.sensicomfort.com'
15
+
16
+ end
@@ -0,0 +1,80 @@
1
+ require "sensi/version"
2
+ require 'httparty'
3
+ require 'curb'
4
+ require 'json'
5
+
6
+ module Sensi
7
+
8
+ class Account
9
+ include Sensi
10
+
11
+ attr_accessor :token, :auth_response, :token_response, :headers, :cookie_hash, :auth_cookie
12
+
13
+ @auth_response
14
+ @token_response
15
+ @token
16
+ @username
17
+ @password
18
+ @cookie_hash
19
+ @auth_cookie
20
+ @headers
21
+
22
+ def initialize(username, password)
23
+ @username = username
24
+ @password = password
25
+ self
26
+ end
27
+
28
+ def login
29
+ authorize(@username, @password)
30
+ parse_cookies(@auth_response.get_fields('Set-Cookie'))
31
+ save_auth_cookie
32
+ add_auth_cookie_to_headers(@auth_cookie)
33
+ get_connection_token
34
+ end
35
+
36
+ def authorize(username, password)
37
+ @auth_response = HTTParty.post(
38
+ Sensi::API_URI + '/api/authorize',
39
+ body: {UserName: username, Password: password}.to_json,
40
+ headers: {'Accept' => 'application/json; version=1, */*; q=0.01', 'X-Requested-With' => 'XMLHttpRequest', 'Content-Type' => 'application/json'}
41
+ )
42
+ end
43
+
44
+ def get_connection_token
45
+ @token_response = Curl.get(Sensi::API_URI + '/realtime/negotiate') do |req|
46
+ req.headers['Cookie'] = @auth_cookie
47
+ req.headers['Accept'] = 'application/json; version=1, */*; q=0.01'
48
+ end
49
+
50
+ @token = JSON.parse(@token_response.body)['ConnectionToken']
51
+ # @token_response = HTTParty.get(
52
+ # Sensi::API_URI + '/realtime/negotiate',
53
+ # headers: Sensi::DEFAULT_HEADERS
54
+ # )
55
+ # @token = @token_response['ConnectionToken']
56
+ end
57
+
58
+ def add_auth_cookie_to_headers(auth_cookie)
59
+ @headers = {'Accept' => 'application/json; version=1, */*; q=0.01','Cookie' => auth_cookie}
60
+ end
61
+
62
+ def parse_cookies(response_cookies)
63
+ @cookie_hash = HTTParty::CookieHash.new
64
+ response_cookies.each do |cookie|
65
+ @cookie_hash.add_cookies(cookie)
66
+ end
67
+ end
68
+
69
+ def save_auth_cookie
70
+ @auth_cookie = @cookie_hash.to_cookie_string
71
+ end
72
+
73
+ def logout
74
+ HTTParty.delete(
75
+ Sensi::API_URI + '/api/authorize',
76
+ headers: {'Coookie' => @auth_cookie, 'Accept' => 'application/json; version=1, */*; q=0.01'}
77
+ )
78
+ end
79
+ end
80
+ end
@@ -0,0 +1,74 @@
1
+ require "sensi/version"
2
+ require 'json'
3
+
4
+ module Sensi
5
+
6
+ class HashToObject
7
+
8
+ TEST = {'C': 'abc', 'A': ["hi", {:should=>"see"}], 'M': ['on','off','shutdown'], 'D': {'hola': 'hello'}, num: 5}
9
+
10
+ def initialize(hash = TEST, debug = false)
11
+ convert(hash, debug)
12
+ end
13
+
14
+ def convert(obj, debug = false)
15
+ obj.each do |obj|
16
+ puts "#{obj}" if debug
17
+ if obj.is_a? Array
18
+ puts 'found array' if debug
19
+ if obj.size == 2 and !obj[1].is_a? Hash and !obj[1].is_a? Array
20
+ puts 'found key/value' if debug
21
+ add_var(obj[0].to_s, obj[1])
22
+ elsif obj.size == 2 and obj[1].is_a? Hash
23
+ puts 'found hash' if debug
24
+ add_var(obj[0].to_s, HashToObject.new(obj[1]))
25
+ elsif obj.size == 2 and obj[1].is_a? Array and contains_hash(obj[1])
26
+ puts 'found array and contains hash' if debug
27
+ add_var(obj[0].to_s, HashToObject.new(obj[1]))
28
+ elsif obj.size == 2 and obj[1].is_a? Array
29
+ puts 'found array and array' if debug
30
+ add_var(obj[0].to_s, obj[1])
31
+ elsif obj.size > 2
32
+ puts 'found other' if debug
33
+ obj.each do |item|
34
+ add_var(k.to_s, HashToObject.new(item))
35
+ end
36
+ end
37
+ elsif obj.is_a? Hash
38
+ puts 'found hash 2' if debug
39
+ obj.each do |k, v|
40
+ if v.is_a? Array or v.is_a? Hash
41
+ add_var(k.to_s, HashToObject.new(v))
42
+ else
43
+ add_var(k.to_s,v)
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
49
+
50
+ def contains_hash(arr)
51
+ arr.each do |item|
52
+ return true if item.is_a? Hash
53
+ end
54
+ false
55
+ end
56
+
57
+ def add(k, v)
58
+ self.instance_variable_set("@#{k.underscore}", v)
59
+ self.class.send(:define_method, k.underscore, proc{self.instance_variable_get("@#{k.underscore}")})
60
+ self.class.send(:define_method, "#{k.underscore}=", proc{|v| self.instance_variable_set("@#{k.underscore}", v)})
61
+ end
62
+
63
+ def add_var(k, v)
64
+ (class << self; self; end).class_eval do
65
+ # self.instance_variable_set("@#{k.underscore}", v)
66
+ define_method( k.underscore, proc{ instance_variable_get("@#{k.underscore}") } )
67
+ define_method( "#{k.underscore}=", proc{ |v| instance_variable_set("@#{k.underscore}", v) } )
68
+ end
69
+ self.instance_variable_set("@#{k.underscore}", v)
70
+ end
71
+
72
+ end
73
+
74
+ end
@@ -0,0 +1,28 @@
1
+ require "sensi/version"
2
+ require 'sensi/hash_to_object'
3
+
4
+ module Sensi
5
+
6
+ class PollResponse < HashToObject
7
+
8
+ attr_reader :json
9
+
10
+ def initialize(json)
11
+ @json = json
12
+ convert(json)
13
+ end
14
+
15
+ def message_id
16
+ self.c
17
+ end
18
+
19
+ def groups_token
20
+ self.g
21
+ end
22
+
23
+ def timed_out?
24
+ respond_to?(:t)
25
+ end
26
+ end
27
+
28
+ end
@@ -0,0 +1,13 @@
1
+ require 'hash_to_object'
2
+
3
+ module Sensi
4
+
5
+ class Response < HashToObject
6
+
7
+ def initialize(hash)
8
+ convert(hash)
9
+ end
10
+
11
+ end
12
+
13
+ end
@@ -0,0 +1,12 @@
1
+ require "sensi/version"
2
+ require 'sensi/json_to_object'
3
+
4
+ module Sensi
5
+
6
+ class Settings < JsonToObject
7
+
8
+
9
+
10
+ end
11
+
12
+ end
@@ -0,0 +1,207 @@
1
+ require "sensi/version"
2
+ require 'sensi/hash_to_object'
3
+ require 'sensi/thermostat_connection'
4
+
5
+ module Sensi
6
+
7
+ class Thermostat < HashToObject
8
+
9
+ attr_accessor :account, :thermostat_connection
10
+
11
+ @account
12
+ @thermostat_connection
13
+
14
+ #private vars
15
+ @mode
16
+ @heat
17
+ @cool
18
+ @fan
19
+ @schedule
20
+
21
+ def initialize(login, password)
22
+ @account = Sensi::Account.new(login, password)
23
+ @thermostat_connection = Sensi::ThermostatConnection.new(@account)
24
+ end
25
+
26
+ def connect
27
+ @account.login
28
+ get_account_info
29
+ connect_to_device
30
+ end
31
+
32
+ def disconnect
33
+ @thermostat_connection.stop_polling
34
+ @account.logout
35
+ end
36
+
37
+ def get_account_info
38
+ convert(@thermostat_connection.get_info)
39
+ end
40
+
41
+ def connect_to_device(connection_attempt = 3)
42
+ attempt = 1
43
+ while not connected_to_device? and attempt < connection_attempt
44
+ @thermostat_connection.connect
45
+ @thermostat_connection.initialize_polling(self.icd)
46
+ convert(@thermostat_connection.start_polling)
47
+ attempt += 1
48
+ end
49
+
50
+ @heat = settings.heat_setpoint
51
+ @cool = settings.cool_setpoint
52
+ @mode = system_mode
53
+ @schedule = nil
54
+ @fan = 'Auto'
55
+
56
+ return connected_to_device?
57
+ end
58
+
59
+ def connected_to_device?
60
+ self.m.respond_to?(:m)
61
+ rescue
62
+ false
63
+ end
64
+
65
+ def update
66
+ response = @thermostat_connection.poll
67
+ self.m.a.operational_status = response.m.a.operational_status unless response.timed_out?
68
+ !response.timed_out?
69
+ end
70
+
71
+ def system_modes
72
+ self.m.a.capabilities.system_modes
73
+ end
74
+
75
+ def equipment
76
+ self.m.a.capabilities.outdoor_equipment
77
+ end
78
+
79
+ def settings
80
+ self.m.a.environment_controls
81
+ end
82
+
83
+ def active_mode
84
+ self.m.a.operational_status.running.mode
85
+ end
86
+
87
+ def active_time
88
+ self.m.a.operational_status.running.time
89
+ rescue
90
+ "0"
91
+ end
92
+
93
+ def temperature(scale: :F)
94
+ case scale
95
+ when :F
96
+ return self.m.a.operational_status.temperature.f
97
+ when :C
98
+ return self.m.a.operational_status.temperature.c
99
+ else
100
+ raise ArgumentError, "Scale #{scale} is not valid."
101
+ end
102
+ end
103
+
104
+ def humidity
105
+ self.m.a.operational_status.humidity
106
+ end
107
+
108
+ def system_mode
109
+ self.m.a.operational_status.operating_mode
110
+ end
111
+
112
+ def system_fan
113
+ nil
114
+ end
115
+
116
+ # def set(mode: nil, temp: 70, scale: :F, fan: :auto, schedule: :off)
117
+ def set(args)
118
+ # case mode
119
+ # when :heat
120
+ # @thermostat_connection.set(self.icd, 'SetSystemMode', mode.to_s.capitalize) unless system_mode == mode.to_s.capitalize
121
+ # when :cool
122
+ # @thermostat_connection.set(self.icd, 'SetSystemMode', mode.to_s.capitalize) unless system_cool_on?
123
+ # end
124
+ args.each do |k, v|
125
+ case k
126
+ when :mode
127
+ @thermostat_connection.set(self.icd, 'SetSystemMode', v.to_s.capitalize) unless system_mode == mode.to_s.capitalize
128
+ when :fan
129
+ @thermostat_connection.set(self.icd, 'SetFanMode', v.to_s.capitalize) unless system_fan_on?
130
+ when :temp
131
+ @thermostat_connection.set(self.icd, 'SetHeat', v.to_s.capitalize, scale.to_s.capitalize) unless system_temperature(:heat) == temp
132
+
133
+ @thermostat_connection.set(self.icd, 'SetCool', v.to_s.capitalize, scale.to_s.capitalize) unless system_temperature(:cool) == temp
134
+ when :schedule
135
+ @thermostat_connection.set(self.icd, 'SetScheduleMode', v.to_s.capitalize) unless system_schedule == args
136
+ end
137
+ end
138
+ end
139
+
140
+ # def mode(mode)
141
+ # @thermostat_connection.set(self.icd, 'SetSystemMode', mode.to_s.capitalize)
142
+ # end
143
+
144
+ def heat_on?
145
+ system_mode == 'Heat'
146
+ end
147
+
148
+ def cool_on?
149
+ system_mode == 'Cool'
150
+ end
151
+
152
+ def aux_on?
153
+ system_mode == 'Aux'
154
+ end
155
+
156
+
157
+ def system_on?
158
+ system_mode != 'Off'
159
+ end
160
+
161
+ def system_off?
162
+ system_mode == 'Off'
163
+ end
164
+
165
+ def system_heat_on?
166
+ system_mode == 'Heat'
167
+ end
168
+
169
+ def system_cool_on?
170
+ system_mode == 'Cool'
171
+ end
172
+
173
+ def system_aux_on?
174
+ system_mode == 'Aux'
175
+ end
176
+
177
+ def system_auto_on?
178
+ system_mode =- 'Auto'
179
+ end
180
+
181
+ def system_temperature(type)
182
+ case type
183
+ when :heat
184
+ return settings.heat_setpoint.f
185
+ when :cool
186
+ return settings.cool_setpoint.f
187
+ else
188
+ raise ArgumentError, "Type #{type} not valid."
189
+ end
190
+ end
191
+
192
+ # def system_heat_setpoint
193
+ # settings.heat_setpoint
194
+ # end
195
+
196
+ # def system_cool_setpoint
197
+ # settings.cool_setpoint
198
+ # end
199
+
200
+ def system_fan_on?
201
+ nil
202
+ end
203
+
204
+
205
+ end
206
+
207
+ end
@@ -0,0 +1,149 @@
1
+ require "sensi/version"
2
+ require 'httparty'
3
+ require 'curb'
4
+ require 'json'
5
+ require 'cgi'
6
+
7
+ require 'sensi/account'
8
+ require 'sensi/thermostat'
9
+ require 'sensi/poll_response'
10
+
11
+ module Sensi
12
+
13
+ class ThermostatConnection
14
+ include Sensi
15
+
16
+ attr_accessor :account, :thermostat_info, :response, :headers, :message_id, :first_poll_response, :groups_token
17
+
18
+ @response
19
+ @first_poll_response
20
+ @account
21
+ @thermostat_info
22
+ @message_id
23
+ @headers
24
+ @groups_token
25
+
26
+ def initialize(account)
27
+ @account = account
28
+ @headers = {'Accept' => 'application/json; version=1, */*; q=0.01',
29
+ 'Content-Type' => 'application/x-www-form-urlencoded; charset=UTF-8',
30
+ 'Cookie' => @account.auth_cookie
31
+ }
32
+ end
33
+
34
+ def get_info
35
+ @response = HTTParty.get(
36
+ Sensi::API_URI + '/api/thermostats',
37
+ headers: @account.headers
38
+ )
39
+ @thermostat_info = JSON.parse(@response.body)
40
+ end
41
+
42
+
43
+ def set(device_id, setting, *args)
44
+ setting_args = [device_id]
45
+ args.each do |arg|
46
+ setting_args.push(arg)
47
+ end
48
+
49
+ response = HTTParty.post(
50
+ Sensi::API_URI + '/realtime/send',
51
+ query: {transport: 'longPolling', connectionToken: @account.token},
52
+ body: encode("{H: 'thermostat-v1', M: '#{setting}', A: #{setting_args}, I: 0}"),
53
+ headers: {"Cookie" => @account.auth_cookie}
54
+ )
55
+ #response
56
+ response.code == 200
57
+ end
58
+
59
+ def connect
60
+ response = HTTParty.get(
61
+ Sensi::API_URI + '/realtime/connect',
62
+ query: {transport: 'longPolling',
63
+ connectionToken: @account.token,
64
+ connectionData: '[{"name": "thermostat-v1"}]',
65
+ tid: 4,
66
+ _: (Time.now.to_f*1000).to_i},
67
+ headers: {"Cookie" => @account.auth_cookie}
68
+ )
69
+ @message_id = JSON.parse(response.body)['C']
70
+ response
71
+ end
72
+
73
+ # def initialize_polling(device_id)
74
+ # response = HTTParty.post(
75
+ # Sensi::API_URI + '/realtime/send',
76
+ # query: {transport: 'longPolling', connectionToken: @account.token},
77
+ # body: encode("{H: 'thermostat-v1', M: 'Subscribe', A:['#{device_id}'], I: 0}"),
78
+ # headers: {"Cookie" => @account.auth_cookie}
79
+ # )
80
+ # response
81
+ # end
82
+
83
+ def initialize_polling(device_id)
84
+ set(device_id, 'Subscribe')
85
+ end
86
+
87
+ def start_polling
88
+ @first_poll_response = HTTParty.get(
89
+ Sensi::API_URI + '/realtime/poll',
90
+ query: {transport: 'longPolling',
91
+ connectionToken: @account.token,
92
+ connectionData: '[{"name": "thermostat-v1"}]',
93
+ tid: 4,
94
+ _: (Time.now.to_f*1000).to_i,
95
+ messageId: @message_id},
96
+ headers: {"Cookie" => @account.auth_cookie}
97
+ )
98
+
99
+ json = JSON.parse(@first_poll_response.body)
100
+ poll_response = Sensi::PollResponse.new(json)
101
+ @message_id = poll_response.message_id
102
+ @groups_token = poll_response.groups_token
103
+ # json = JSON.parse(@first_poll_response.body)
104
+ # @message_id = json['C']
105
+ # @groups_token = json['G']
106
+ # @first_poll_response
107
+ json
108
+ rescue
109
+ json
110
+ end
111
+
112
+ def poll
113
+ response = HTTParty.get(
114
+ Sensi::API_URI + '/realtime/poll',
115
+ query: {transport: 'longPolling',
116
+ connectionToken: @account.token,
117
+ connectionData: '[{"name": "thermostat-v1"}]',
118
+ tid: 4,
119
+ _: (Time.now.to_f*1000).to_i,
120
+ messageId: @message_id,
121
+ groupsToken: @groups_token},
122
+ headers: {"Cookie" => @account.auth_cookie}
123
+ )
124
+
125
+ poll_response = Sensi::PollResponse.new(JSON.parse(response.body))
126
+ @message_id = poll_response.message_id
127
+ # json = JSON.parse(response.body)
128
+ # @message_id = json['C']
129
+ poll_response
130
+ end
131
+
132
+ def stop_polling
133
+ response = HTTParty.post(
134
+ Sensi::API_URI + '/realtime/abort',
135
+ query: {transport: 'longPolling', connectionToken: @account.token},
136
+ body: '',
137
+ headers: {'Cookie' => @account.auth_cookie}
138
+ )
139
+ end
140
+
141
+
142
+ private
143
+
144
+ def encode(text)
145
+ "data=#{CGI.escape(text)}"
146
+ end
147
+
148
+ end
149
+ end
@@ -0,0 +1,16 @@
1
+ require "sensi/version"
2
+ require 'json'
3
+
4
+ module Sensi
5
+
6
+ class ::String
7
+ def underscore
8
+ self.gsub(/::/, '/').
9
+ gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
10
+ gsub(/([a-z\d])([A-Z])/,'\1_\2').
11
+ tr("-", "_").
12
+ downcase
13
+ end
14
+ end
15
+
16
+ end
@@ -0,0 +1,3 @@
1
+ module Sensi
2
+ VERSION = "0.0.1"
3
+ end
data/sensi.gemspec ADDED
@@ -0,0 +1,32 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'sensi/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "sensi"
8
+ spec.version = Sensi::VERSION
9
+ spec.authors = ["Chris Kirby"]
10
+ spec.email = ["kirbycm@gmail.com"]
11
+
12
+ spec.summary = %q{Emmerson Sensi thermostat API wrapper.}
13
+ spec.description = %q{Emmerson Sensi thermostat API wrapper.}
14
+ spec.homepage = "https://github.com/kirbs-/sensi"
15
+ spec.license = "GNU General Public License v2.0"
16
+
17
+ # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
18
+ # delete this section to allow pushing this gem to any host.
19
+ # if spec.respond_to?(:metadata)
20
+ # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
21
+ # else
22
+ # raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
23
+ # end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+
30
+ spec.add_development_dependency "bundler", "~> 1.10"
31
+ spec.add_development_dependency "rake", "~> 10.0"
32
+ end
metadata ADDED
@@ -0,0 +1,91 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: sensi
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Chris Kirby
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-03-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ description: Emmerson Sensi thermostat API wrapper.
42
+ email:
43
+ - kirbycm@gmail.com
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - ".gitignore"
49
+ - CODE_OF_CONDUCT.md
50
+ - Gemfile
51
+ - LICENSE.txt
52
+ - README.md
53
+ - Rakefile
54
+ - bin/console
55
+ - bin/setup
56
+ - lib/sensi.rb
57
+ - lib/sensi/account.rb
58
+ - lib/sensi/hash_to_object.rb
59
+ - lib/sensi/poll_response.rb
60
+ - lib/sensi/response.rb
61
+ - lib/sensi/settings.rb
62
+ - lib/sensi/thermostat.rb
63
+ - lib/sensi/thermostat_connection.rb
64
+ - lib/sensi/utils.rb
65
+ - lib/sensi/version.rb
66
+ - sensi.gemspec
67
+ homepage: https://github.com/kirbs-/sensi
68
+ licenses:
69
+ - GNU General Public License v2.0
70
+ metadata: {}
71
+ post_install_message:
72
+ rdoc_options: []
73
+ require_paths:
74
+ - lib
75
+ required_ruby_version: !ruby/object:Gem::Requirement
76
+ requirements:
77
+ - - ">="
78
+ - !ruby/object:Gem::Version
79
+ version: '0'
80
+ required_rubygems_version: !ruby/object:Gem::Requirement
81
+ requirements:
82
+ - - ">="
83
+ - !ruby/object:Gem::Version
84
+ version: '0'
85
+ requirements: []
86
+ rubyforge_project:
87
+ rubygems_version: 2.4.6
88
+ signing_key:
89
+ specification_version: 4
90
+ summary: Emmerson Sensi thermostat API wrapper.
91
+ test_files: []