SmartRubyPlug 0.1.2.beta → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9c8f495e70e0f07101a046e10a58eead888fa5ef135002d336dbbee3adcb2ce
-  data.tar.gz: 2dc8c5fa4bfa377303fe44902fc32cefcb698e285abe508f4fca5a78013cc2c0
+  metadata.gz: fea9e4a921b4c63967cca9b5699c95367f5b433d6369b5a059de9ce637d75e5e
+  data.tar.gz: 81f22b51523d4d4bb2f80a3635ecbe027f38ca0db1a02c6ab746546fd6f37416
 SHA512:
-  metadata.gz: 554cddb7425c5c190c30c5ea2485da11a497f6d1025de4a80212879de1a9d0bb8468834645df18c0609db65466e64bb467f96e12613d75750529e6281c89acd9
-  data.tar.gz: 0c549d24ab46fd59454f3e19d939071af4687ef4058124487ef82c06062dc97292419e61560aa595be93c8b600be4eedaad1d4969ea81174a35a5ce66a3721b9
+  metadata.gz: 7d24049153e426fd8ed867071b02b59733237708ac215359a95edcda316203350e652774e0620108a6e54410c6f845b8bfb0c2559de2aff2eb7813ea4ee86cb3
+  data.tar.gz: 68988542dddcbbebf971875432878b6c338e23e228757650193ee2e2da749e0d0737e6c884cc9b79235a66048a483bcd3ea998a08edb6ab3197875fc92155380

data/Changelog.md

@@ -1,3 +1,8 @@
+## 0.2.0
+- fix issue, when Home Assistant node was not reachable and the exception was bubbling up, which caused app exit
+- fix the case, when app was exited, if wifi or internet IP was not reachable
+- fix missing ping package for Docker build
+
 ## 0.1.2.beta
 - fix gemspec
 

data/README.md

@@ -7,7 +7,8 @@ The project has 3 repositories
 - [Matho/smart_ruby_plug_c](https://github.com/Matho/smart_ruby_plug_c) - C source code for those, who want to change the drawing on the Raspberry Pi display
 - [Matho/smart_ruby_plug_c_binaries](https://github.com/Matho/smart_ruby_plug_c_binaries) - prebuilded C binaries (.so file) for those, who do not want to build the binary from source code
 
-You can find the **demo video** at [this link](http://websupport.matho.sk/smart_plug.webm)
+You can find the **demo video** at [this link](http://websupport.matho.sk/smart_plug.webm)  
+See [wiki](https://github.com/Matho/smart_ruby_plug/wiki/End-User-manual) for end-user manual.
 
 ## 1. The motivation behind this project
 Imagine the following situation:
@@ -26,7 +27,8 @@ It can cut your energy bill dramatically!
 The idea is, that you will provide Raspberry Pi with LCD display to your neighbor and he will have option to turn your Starlink dish on, for case it is off (it is scheduled for turning off at midnight for each night)
 
 The hardware you need to buy:
-- you have to buy 2x Raspberry Pi (preferred is Raspberry Pi 4B, but you can use any aarch64 supported, like Raspberry Pi 3B and higher) 2GB memory model should be good enough
+- you have to buy 2x Raspberry Pi. You need min 1GB ram model for Home Assistant node and min512MB ram model for the remote device. 
+- the project works both on armv7l and aarch64
 - the first one will be used as remote control and the second one as master node with `Home Assistant` smart home software
 - then I have bought [Waveshare 1,3" IPS LCD display HAT 240×240](https://www.waveshare.com/1.3inch-lcd-hat.htm) for the RPI used to act as remote device
 - you need also some 2x MicroSD card, 32GB should be good enough
@@ -58,20 +60,21 @@ I have identified following costs:
 
 - display ... 16 EUR
 - smart plug ... 38 EUR
-- 2x Raspberry Pi 2GB model ... 2x51 EUR
+- 1x Raspberry Pi 1GB model ... 45 EUR
+- 1x Raspbery Pi Zero 2W with GPIO header .... 23 EUR 
 - 2x power adapter .. 2x10EUR
 - 2x ethernet cable ... 2x1.5EUR
 - 2x micro SD card ... 2x8EUR
 - 2x some rpi case ... optional
 - shipping for orders from eshops ... unknown/optional
 
-Total*: 195 EUR
+Total*: 151 EUR
 
 **Note:** The yearly energy bill is expected at `430Kwh` It should cost about 100 EUR / year. 
 I expect you can sell the used items on bazaar after few years with 70% of buy price,
-so **your initial costs in this case would be only 59 EUR.** Also, you need to include here the saved energy costs.
+so **your initial costs in this case would be only 46 EUR.** Also, you need to include here the saved energy costs.
 
-**Note 2:** For the remote device rpi, maybe you could use Raspberry PI Zero 2W. This model is aarch64 compatible. When you use Ubuntu Core distribution, it could be running. But it has not been tested yet.
+**Note 2:** Raspbery Pi Zero 2W was not tested by me. But based on the its parameters, it should work too. The memory consumption on the node with Home Assistant is about 500MB. Not sure, but maybe it would work on RPI ZERO 2W also for the master node.
 
 **Note 3:** Currently there is big issue with Raspberry Pi availability. The costs on Ebay are sometimes more then twice the price I'm including on this purchase list.
 
@@ -178,7 +181,7 @@ change the password immediately. You can set ssh keys to do not require copy pas
 
 If you dont want to use ethernet port for internet, but wifi instead, I recommend to check this article [https://arstech.net/raspberry-pi-4-ubuntu-wifi/](https://arstech.net/raspberry-pi-4-ubuntu-wifi/)
 
-**The easiest way is install this project via Docker**. See chapter `6. Dockerfile building and running via Docker` for more info.
+**The easiest way is install this project via Docker**. See chapter `6. Dockerfile building and running via Docker` for more info. I recommend Docker also for the case - when the app failed (exit), the Docker container can restart the container automatically. 
 
 Now we need to install [RVM](https://rvm.io/). RVM is Ruby Version Manager and with RVM you can install multiple Ruby language versions in the same OS and switch between versions easily.
 
@@ -359,6 +362,9 @@ Log in to your raspberry pi, `cd` to the project and run:
 
 The project need the prebuilded `.so` file. 
 
+### 5.1 Running rspec on amd64 machine
+Alternatively, you can use prebuilded `libsmart_plug_C.so.for_tests` located in `lib/clibrary`. This is "empty" clibrary file, so it is able to run 
+it also on amd64 machine, without needed C packages. You can rename it to `libsmart_plug_C.so` and start the tests on  your localhost (not from rpi).
 
 ## 6. Dockerfile building and running via Docker
 
@@ -375,7 +381,7 @@ software-properties-common
 ```
 curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
 ```
-Use proper architecture - `arm64` for > Raspberry Pi 3B or `armhf` for < Raspberry Pi 2B
+Use proper architecture - `arm64` for >= Raspberry Pi 3B or `armhf` for <= Raspberry Pi 2B
 ```
 sudo add-apt-repository \
 "deb [arch=arm64] https://download.docker.com/linux/ubuntu \
@@ -392,20 +398,22 @@ sudo docker run hello-world
 ```
 
 ### 6.2 Build this image
+If you want to only run the image with last version, skip to docker-compose tutorial in next section.
+
 `cd ~/docker-builds/smart_ruby_plug`  
 Pass `--no-cache` for clean build and pass correct url with C binary version for C_BINARY_PATH arg.
 
 For aarch64:  
-`sudo docker build -t mathosk/smart_ruby_plug:v0.1.0.beta_aarch64 --build-arg ARCH=aarch64 --build-arg C_BINARY_PATH=https://github.com/Matho/smart_ruby_plug_c_binaries/releases/download/v0.1.0.beta/libsmart_plug_C.so.v0.1.0.beta_77865ad7af .`
+`sudo docker build -t mathosk/smart_ruby_plug:v0.2.0_aarch64 --build-arg ARCH=aarch64 --build-arg C_BINARY_PATH=https://github.com/Matho/smart_ruby_plug_c_binaries/releases/download/v0.1.0.beta/libsmart_plug_C.so.v0.1.0.beta_77865ad7af .`
 
 Alternatively for armv7l:  
-`sudo docker build -t mathosk/smart_ruby_plug:v0.1.0.beta_armv7l --build-arg ARCH=armv7l --build-arg C_BINARY_PATH=https://github.com/Matho/smart_ruby_plug_c_binaries/raw/master/armv7l_32/v0.1.0/libsmart_plug_C.so.v0.1.0.beta_77865ad7af .`
+`sudo docker build -t mathosk/smart_ruby_plug:v0.2.0_armv7l --build-arg ARCH=armv7l --build-arg C_BINARY_PATH=https://github.com/Matho/smart_ruby_plug_c_binaries/raw/master/armv7l_32/v0.1.0/libsmart_plug_C.so.v0.1.0.beta_77865ad7af .`
 
 ### 6.3 Execute
 `-d` means detached - running in background. If you do not want to run it in background (for test purposes) remove `-d` option from command line
 
 ```
-sudo docker run --privileged -d mathosk/smart_ruby_plug:v0.1.0.beta 
+sudo docker run --privileged -d mathosk/smart_ruby_plug:v0.2.0 
 ```
 
 **Note:** amd64 arch is not prebuilded, as you need to run this sw on the Raspberry Pi. 
@@ -435,4 +443,8 @@ In standby mode, without this application, it takes 180MB ram. With this app it
 
 ## 7. TODOs
 - add display redrawer specs
-- tag and push to RubyGems, once ready to use it in production
+- when app is (re)started, redraw screem, to white, for example
+- cloning external libraries during Docker build from this project repo / or ftp under my control
+- do not do git clone of master branch of WiringPi library, but specific tag, to be sure things doesnt break in future
+- persist logs, instead of stdout only
+- implement log rotation and deletion, to save disk space

data/lib/smart_ruby_plug/processor.rb

@@ -9,6 +9,7 @@ module SmartRubyPlug
 
     def process
       while true do
+        #sleep(10) # TODO uncomment if you are developing on non-Raspberry Pi architecture
         SmartRubyPlug::StdoutLogger.logger.debug('Running processor with ping checks ...')
 
         smart_plug_status = smart_plug_check
@@ -26,7 +27,7 @@ module SmartRubyPlug
           @wifi_output = wifi_check
           unless @wifi_output == []
             redraw_display_with_error(@wifi_output)
-            return
+            next
           end
         end
 
@@ -34,7 +35,7 @@ module SmartRubyPlug
           @internet_output = internet_check
           unless @internet_output == []
             redraw_display_with_error(@internet_output)
-            return
+            next
           end
         end
       end

data/lib/smart_ruby_plug/requests/smart_plug_on_request.rb

@@ -6,14 +6,18 @@ module SmartRubyPlug
       SUCCESS_API_MESSAGE = 'OK'.freeze
 
       def do_request
-        response = HTTParty.post(do_request_url,
-                                 body: {
-                                   "entity_id": @plug_entity_id
-                                 }.to_json,
-                                 headers: {
-                                   "content-type" => 'application/json',
-                                   "Authorization" => "Bearer #{@long_lived_token}"
-                                 })
+        begin
+          response = HTTParty.post(do_request_url,
+                                   body: {
+                                     "entity_id": @plug_entity_id
+                                   }.to_json,
+                                   headers: {
+                                     "content-type" => 'application/json',
+                                     "Authorization" => "Bearer #{@long_lived_token}"
+                                   })
+        rescue => e
+          return false
+        end
 
         response.code == SUCCESS_API_CODE && response.message == SUCCESS_API_MESSAGE
       end

data/lib/smart_ruby_plug/requests/smart_plug_status_request.rb

@@ -5,11 +5,15 @@ module SmartRubyPlug
       API_STATUS_PATH = '/api/states/'.freeze
 
       def do_request
-        response = HTTParty.get(do_request_url,
-                                headers: {
-                                  "content-type" => 'application/json',
-                                  "Authorization" => "Bearer #{@long_lived_token}"
-                                })
+        begin
+          response = HTTParty.get(do_request_url,
+                                  headers: {
+                                    "content-type" => 'application/json',
+                                    "Authorization" => "Bearer #{@long_lived_token}"
+                                  })
+        rescue => e
+          return nil
+        end
 
         # request has failed, we dont know if plug is on or off
         return nil unless request_passed?(response)

data/lib/smart_ruby_plug/version.rb

@@ -1,5 +1,5 @@
 module SmartRubyPlug
   class Version
-    VERSION = "0.1.2.beta".freeze
+    VERSION = '0.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: SmartRubyPlug
 version: !ruby/object:Gem::Version
-  version: 0.1.2.beta
+  version: 0.2.0
 platform: ruby
 authors:
 - Martin Markech
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -99,9 +99,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: 1.3.5
 requirements: []
 rubygems_version: 3.3.7
 signing_key: