From 38de4e5e4a60d16f86a28c76f99d8e701a6c547e Mon Sep 17 00:00:00 2001 From: Aayush Raj Date: Thu, 15 Aug 2024 21:28:11 +0530 Subject: [PATCH] initial commit Sensor library to be copied in the site-packages of python so that it is accessible throughout Sugar from any activity Sensors/Functions included: - Digital input/output (LEDs, IR, etc.) - Delay (in milliseconds) - Button - HC-SR04 Ultrasonic distance sensor - DHT Temperature and Humidity sensor (not tested) - OLED display - PIR Sensor (not tested) - PWM control (LED brightness, motor speed, etc.) - DC Motor (not tested) --- COPYING | 340 ---------------------------------------- NEWS => README.MD | 0 __init__.py | 17 -- activity.py | 0 activity/activity.info | 8 - activity/sensor.svg | 4 - req.txt | 7 + rpi.py | 1 + sensors/general.py | 188 ++++++++++++++++++++++ sensors/oled_display.py | 59 +++++++ setup.py | 4 - 11 files changed, 255 insertions(+), 373 deletions(-) delete mode 100644 COPYING rename NEWS => README.MD (100%) delete mode 100644 __init__.py delete mode 100644 activity.py delete mode 100644 activity/activity.info delete mode 100644 activity/sensor.svg create mode 100644 req.txt create mode 100644 rpi.py create mode 100644 sensors/general.py create mode 100644 sensors/oled_display.py delete mode 100644 setup.py diff --git a/COPYING b/COPYING deleted file mode 100644 index 623b625..0000000 --- a/COPYING +++ /dev/null @@ -1,340 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc. - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Library General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - , 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Library General -Public License instead of this License. diff --git a/NEWS b/README.MD similarity index 100% rename from NEWS rename to README.MD diff --git a/__init__.py b/__init__.py deleted file mode 100644 index f7a7d14..0000000 --- a/__init__.py +++ /dev/null @@ -1,17 +0,0 @@ -import os -import site -os.system('sudo cp -ru ./rpi '+site.getsitepackages()[0]) - -import os -import subprocess -cwd = os.getcwd() - -try: - with open('/sys/firmware/devicetree/base/model', 'r') as file: - info = file.read() - if "Raspberry" in info: - is_rpi = True - else: - raise -except Exception: - raise diff --git a/activity.py b/activity.py deleted file mode 100644 index e69de29..0000000 diff --git a/activity/activity.info b/activity/activity.info deleted file mode 100644 index f5c1442..0000000 --- a/activity/activity.info +++ /dev/null @@ -1,8 +0,0 @@ -[Activity] -name = RPiSensors -activity_version = 1 -bundle_id = org.sugarlabs.RPiSensors -exec = sugar-activity3 activity.RPiSensorsActivity -icon = sensor -license = GPLv2+ -repository = https://github.com/drLite35/RPi-Sensors \ No newline at end of file diff --git a/activity/sensor.svg b/activity/sensor.svg deleted file mode 100644 index c17cc99..0000000 --- a/activity/sensor.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - - \ No newline at end of file diff --git a/req.txt b/req.txt new file mode 100644 index 0000000..72488e1 --- /dev/null +++ b/req.txt @@ -0,0 +1,7 @@ +RPi.GPIO +adafruit-blinka +adafruit-circuitpython-displayio-ssd1306 +adafruit-circuitpython-ssd1306 +adafruit-circuitpython-display-text +adafruit-circuitpython-hcsr04 +adafruit-circuitpython-dht \ No newline at end of file diff --git a/rpi.py b/rpi.py new file mode 100644 index 0000000..8afcaec --- /dev/null +++ b/rpi.py @@ -0,0 +1 @@ +# import all fns with usage description here \ No newline at end of file diff --git a/sensors/general.py b/sensors/general.py new file mode 100644 index 0000000..c09b4fc --- /dev/null +++ b/sensors/general.py @@ -0,0 +1,188 @@ +# Functions for: +# - Digital output +# - Digital input +# - Delay +# - Button +# - HC-SR04 Ultrasonic distance sensor +# - DHT11 Temperature and Humidity sensor +# - OLED display + + +import os +import time +import pwmio +import board +import digitalio +import subprocess +# from adafruit_motor import servo +import adafruit_dht +import adafruit_motor.motor as motor +import adafruit_hcsr04 + +cwd = os.getcwd() + + +# ------------- Digital output ------------- # +def digitalWrite(pin_no: str, val: float): + if not hasattr(board, pin_no): + return # + send a message + pin = digitalio.DigitalInOut(getattr(board, pin_no)) + pin.direction = digitalio.Direction.OUTPUT + pin.value = int(val) + + +# ------------- Digital input ------------- # +def digitalRead(pin_no: str): + if not hasattr(board, pin_no): + return + pin = digitalio.DigitalInOut(getattr(board, pin_no)) + pin.direction = digitalio.Direction.INPUT + return bool(pin.value) + + +# ------------- Delay ------------- # +def delay(ms: int): + time.sleep(ms / 1000) + + +# ------------- Button ------------- # +def button(pin: str): + button = 0 + try: + button = digitalio.DigitalInOut(getattr(board, pin)) + button.direction = digitalio.Direction.INPUT + except Exception: + None + button.pull = digitalio.Pull.UP + return not button.value + + +# ------------- HC-SR04 Ultrasonic distance sensor ------------- # +class _dist: + def def_dist(self, trigger: str, echo: str): + try: + self.sonar = adafruit_hcsr04.HCSR04( + trigger_pin=getattr(board, trigger), + echo_pin=getattr(board, echo)) + except Exception: + return + + def dst(self): + try: + s = 0.0 + for i in range(20): + if self.sonar.distance < 1: + i = i - 1 + continue + s += self.sonar.distance + return round(s / 20, 1) + except Exception: + return 0.0 + + +dist = _dist() + + +# ------------- DHT Temperature and Humidity sensor ------------- # +class _dht: + def def_dht(self, pin: str): + try: + self.dhtDevice = adafruit_dht.DHT11(getattr(board, pin)) + except Exception: + return + + def temp(self): + try: + return self.dhtDevice.temperature + except Exception: + return 0.0 + + def hum(self): + try: + return self.dhtDevice.humidity + except Exception: + return 0.0 + + +dht = _dht() + + +# ------------- OLED display ------------- # +class _oled: + def define(self, _height, _width, _text_color): + self.width = int(_width) + self.height = int(_height) + self.text_color = int(_text_color) + + def print(self, text): + subprocess.Popen( + "python3 " + + cwd + + "/plugins/rpi/sensors/oled_display.py " + + str(self.height) + + " " + + str(self.width) + + " " + + str(self.text_color) + + " '" + + str(text) + + "'", + shell=True, + ) + + +oled = _oled() + + +# ------------- PIR sensor ------------- # +def pir_motion(pin: str) -> bool: + try: + pir = digitalio.DigitalInOut(getattr(board, pin)) + pir.direction = digitalio.Direction.INPUT + return bool(pir.value) + except Exception: + return False + + +# ------------- SERVO motor ------------- # +# *need to make usability easy and more controlable +# def servo_motor(pin: str, times, pulse_ms: int, frequency=50): +# pwm = pwmio.PWMOut(getattr(board, pin), duty_cycle=2**15, frequency=50) +# servo_m = servo.Servo(pwm) +# duty_cycle = int(pulse_ms / (period_ms / 65535.0)) + +# for i in range(0, times): +# for angle in range(0, 180, 5): # 0 - 180 degrees, 5 Degree steps +# servo.angle = angle +# time.sleep(0.05) +# for angle in range(180, 0, -5): # 180 - 0 degrees, 5 Degree steps +# servo.angle = angle +# time.sleep(0.05) + + +# ------------- PWM led ------------- # +def pwm_led(pin: str, duty_cycle: int): + led = pwmio.PWMOut(getattr(board, pin), frequency=5000, duty_cycle=0) + led.duty_cycle = int(duty_cycle / 100 * 65535) + if duty_cycle == 0: + led.deinit() + +# # Example usage +# pwm_led('D14', 50) # Set to 50% brightness or duty cycle +# sleep(1) # Keep the LED on for 1 second + + +# ------------- DC Motor (not tested yet) ------------- # +def run_dc_motor(pin1, pin2, duration: float): + pwm_a = pwmio.PWMOut(getattr(board, pin1), frequency=5000) + pwm_b = pwmio.PWMOut(getattr(board, pin2), frequency=5000) + + m = motor.DCMotor(pwm_a, pwm_b) + m.decay_mode = 0 + m.throttle = 1.0 + + time.sleep(duration) + m.throttle = 0 + +# Example usage of the function +# run_dc_motor('D14', 'D15', 2) # Run the motor for 2 seconds diff --git a/sensors/oled_display.py b/sensors/oled_display.py new file mode 100644 index 0000000..5037517 --- /dev/null +++ b/sensors/oled_display.py @@ -0,0 +1,59 @@ +import sys +import time +import board +import displayio +from i2cdisplaybus import I2CDisplayBus +from fourwire import FourWire +import terminalio +from adafruit_display_text import label +import adafruit_displayio_ssd1306 + + +def main(width, height, text_color, text): + height = int(height) + width = int(width) + text_color = int(text_color) + displayio.release_displays() + oled_reset = board.D27 + + # Use for I2C + i2c = board.I2C() + display_bus = I2CDisplayBus(i2c, device_address=0x3C, reset=oled_reset) + + # Use for SPI + # spi = board.SPI() + # oled_cs = board.D5 + # oled_dc = board.D6 + # display_bus = FourWire(spi, command=oled_dc, chip_select=oled_cs, + # reset=oled_reset, baudrate=1000000) + display = adafruit_displayio_ssd1306.SSD1306( + display_bus, width=width, height=height + ) + splash = displayio.Group() + display.root_group = splash + + # clear oled + color_bitmap = displayio.Bitmap(width, height, 1) + color_palette = displayio.Palette(1) + color_palette[0] = 0xFFFFFF if text_color == 0 else 0x000000 + bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, + x=0, y=0) + splash.append(bg_sprite) + + # print on oled + if text != "": + if len(text) > 20: + text = text[:20] + text_area = label.Label( + terminalio.FONT, + text=text, + color=0x000000 if text_color == 0 else 0xFFFFFF, + x=5, + y=5, + ) + splash.append(text_area) + time.sleep(0.2) + + +if __name__ == "__main__": + main(sys.argv[1], sys.argv[2], sys.argv[3], sys.argv[4]) diff --git a/setup.py b/setup.py deleted file mode 100644 index 30aca3d..0000000 --- a/setup.py +++ /dev/null @@ -1,4 +0,0 @@ -#!/usr/bin/env python3 - -from sugar3.activity import bundlebuilder -bundlebuilder.start() \ No newline at end of file