From e6baf43f5363aaba76100ec42b3f9d121df9ab0c Mon Sep 17 00:00:00 2001 From: Bryan Date: Fri, 1 Jan 2021 19:22:47 -0600 Subject: [PATCH] initial commit. This is just a clone of the original repository by: rubienr --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 51 +++++++++++++ chip-off.sh | 142 +++++++++++++++++++++++++++++++++++++ 3 files changed, 394 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 chip-off.sh diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..676c599 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +## Description + +This script monitors the battery voltage, battery charge current and a GPIO pin. ++ If battery is low and not charging, or ++ the pin is pulled down (GND) it initiates a shutdown. + +## Installation + +1. **clone** repository to your C.H.I.P. device + + # If not changed: default username "chip" and password "chip". + ssh chip@ + cd + git clone https://github.com/rubienr/chip.git + +2. automatically **start** it from **/etc/rc.local** + + #!/bin/sh -e + # + # rc.local + # + # This script is executed at the end of each multiuser runlevel. + # Make sure that the script will "exit 0" on success or any other + # value on error. + # + # In order to enable or disable this script just change the execution + # bits. + # + # By default this script does nothing. + + # add this line: + /bin/bash /home/chip/chip/chip-off.sh + + exit 0 + +## Adjustment +The battery low **voltage** and **current levels** are adjustable using: + + # SHUTDOWN_MIN_BATTERY_VOLTAGE ... [mV] + SHUTDOWN_MIN_BATTERY_VOLTAGE=2100.0 + # SHUTDOWN_MIN_BATTERY_VOLTAGE ... [mA] + SHUTDOWN_MIN_BATTERY_CURRENT=20.0 + +The shutdown GPIO pin is adjustable using: + + # see http://docs.getchip.com/#how-you-see-gpio + POWER_BUTTON_GPIO_NUMBER="414" + POWER_BUTTON_GPIO="/sys/class/gpio/gpio$POWER_BUTTON_GPIO_NUMBER" + +## Screenshots +![GPIO switch](https://raw.githubusercontent.com/rubienr/chip/master/screenshots/switch.jpg) diff --git a/chip-off.sh b/chip-off.sh new file mode 100644 index 0000000..9926f3a --- /dev/null +++ b/chip-off.sh @@ -0,0 +1,142 @@ +#!/bin/bash/ +# +# @author Raoul R., 2016 +# +# This script watches (polls) the battery state and the gpio $POWER_BUTTON_GPIO pin level. +# If pin is pulled to GND the script initiates a shut down. +# + +# SHUTDOWN_MIN_BATTERY_VOLTAGE ... [mV] +SHUTDOWN_MIN_BATTERY_VOLTAGE=2100.0 +# SHUTDOWN_MIN_BATTERY_VOLTAGE ... [mA] +SHUTDOWN_MIN_BATTERY_CURRENT=20.0 + +# see http://docs.getchip.com/#how-you-see-gpio +POWER_BUTTON_GPIO_NUMBER="414" +POWER_BUTTON_GPIO="/sys/class/gpio/gpio$POWER_BUTTON_GPIO_NUMBER" + +# LOG_LEVEL ... DEBUT | INFO +LOG_LEVEL="DEBUG" + +TRUE=1 +FALSE=0 + + +# $1 ... message +# debug log +function log() { + if [ "$LOG_LEVEL" = "DEBUG" ] ; then + local message=$1 + logger -t "PME" "$message" + fi +} + +# $1 ... message +# more verbose information logging +function logInfo() { + local message=$1 + logger -t "PME" "$message" +} + +function setupGpioInputButton() +{ + if [ ! -e ${POWER_BUTTON_GPIO} ] ; then + echo "$POWER_BUTTON_GPIO_NUMBER" > /sys/class/gpio/export + fi + echo "in" > ${POWER_BUTTON_GPIO}/direction > /dev/null 2>&1 + echo "0" > ${POWER_BUTTON_GPIO}/active_low > /dev/null 2>&1 +} + +function cleanupGpioInputButton() { + echo "$POWER_BUTTON_GPIO_NUMBER" > /sys/class/gpio/unexport +} + +# $1 ... message +function shutdownCommand() { + logInfo "$1" + cleanupGpioInputButton + setLed 1 + shutdown -h 0 & + exit 0 +} + +# @return ... 0,1 as return value +function isBatteryAvailable() { + local flags=$(i2cget -f -y 0 0x34 0x01) + return $(((( $flags&0x20 ) >>5 ) == $TRUE )) +} + +# @return ... voltage as string +function getBatteryVoltage() { + local voltageHighByte=$(i2cget -y -f 0 0x34 0x78) + local voltageLowByte=$(i2cget -y -f 0 0x34 0x79) + local rawVoltage=$(($(($voltageHighByte << 4)) | $(($(($voltageLowByte & 0x0F )))))) + echo "($rawVoltage * 1.1)" | bc +} + +# @return ... charging current as string +function getChargeCurrent() { + local currentHighByte=$(i2cget -f -y 0 0x34 0x7A) + local currentLowByte=$(i2cget -f -y 0 0x34 0x7B) + local rawCurrent=$(($(($currentHighByte << 4)) | $(($(($currentLowByte & 0x0F)))))) + echo "($rawCurrent * 0.5)" | bc +} + +# shuts the system down if too less voltage +function verifyBatteryVoltage() { + isBatteryAvailable + if [ "$?" -eq "1" ] ; then + local voltage=$(getBatteryVoltage) + chargeCurrent=$(getChargeCurrent) + log "battery charge current [${chargeCurrent}mV] min current [${SHUTDOWN_MIN_BATTERY_CURRENT}mV]" + if [ $(echo "$voltage <= $SHUTDOWN_MIN_BATTERY_VOLTAGE" | bc) -eq "1" ] ; then + log "critical battery voltage [${voltage}mV] min voltage [${SHUTDOWN_MIN_BATTERY_VOLTAGE}mV]" + if [ $(echo "$chargeCurrent <= $SHUTDOWN_MIN_BATTERY_CURRENT" | bc) -eq "1" ] ; then + shutdownCommand "shutting down due to low voltage/charge current" + fi + return + fi + log "battery voltage [${voltage}mV] min voltage [${SHUTDOWN_MIN_BATTERY_VOLTAGE}mv]" + fi +} + +# $1 ... led state (0,1) +function setLed() { + if [ "$1" -eq "1" -o "$1" -eq "0" ] ; then + /usr/sbin/i2cset -f -y 0 0x34 0x93 0x$1 + fi +} + +# @return ... true if button pressed else false as return value +function isButtonPressed() { + local value=$(cat ${POWER_BUTTON_GPIO}/value) + + + + if [ "$value" -eq "0" ] ; then + shutdownCommand "shutdown on button pressed" + fi +} + +function verifyButton() { + isButtonPressed + if [ "$?" -eq "1" ] ; then + shutdownCommand "shutdown on power button request" + fi +} + +function main() { + setupGpioInputButton + + while true ; do + setLed 1 + verifyBatteryVoltage + verifyButton + setLed 0 + sleep 3 + done +} + +# start monitoring in subshell and nonblocking +$(main)& +exit 0