Merge pull request #103 from sixfab/dev

Release 0.3.0

Author: ensarkarabudak

.gitignore

@@ -4,6 +4,10 @@ cert/
 ### Configs
 config.json
 
+### MacOS
+pico_lte/.DS_Store
+.DS_Store
+
 ### VSCode Config
 .vscode/
 
@@ -180,3 +184,4 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
+package-lock.json

CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+## [0.3.0] - 2023-10-21
+
+### Added
+
+- Add google sheets app.
+
+### Changed
+
+- Update gps output format as decimal.
+
+
+## [0.2.1] - 2023-09-13
+
+### Added
+
+- Add code examples for apps.
+
+### Changed
+
+- Improve HTTP fault catching.
+- Update Azure app document for simple usage.
+- Update README.md file for last changes and fix link redirects.
+
+### Removed
+
+- Delete I2C class initialization.
+- Remove ULP example. 
+
+### Fixed
+
+- Fix response related error of Scriptr app.
+- Fix memory allocation error while using Azure app.
+
+[0.2.1]: https://github.com/sixfab/pico_lte_micropython-sdk/tree/0.2.1
+[0.3.0]: https://github.com/sixfab/pico_lte_micropython-sdk/tree/0.3.0

README.md

@@ -14,40 +14,55 @@ an embedded framework to make easier cellular connections
 
 </div>
 
-## Description
-PicoLTE SDK is a framework that you can use in your embedded systems projects and **takes care of cellular communication** processes for you. It provides built-in application support for popular back-end services such as Amazon Web Services, Azure, ThingSpeak, Slack, and Telegram.
 
-* Less than 40 lines when making a connection to a built-in application.
-* Support for SSL/TLS certification and their secure storage.
-* Easy-to-use GPS, HTTPS and MQTTS interfaces.
-* Chance to create your own application module with state machines.
+Pico LTE SDK is an innovative framework that enables developers to integrate cellular communication capabilities into their embedded systems projects seamlessly. Pico LTE SDK simplifies the complexities of wireless connectivity, allowing developers to focus on their applications rather than the intricacies of cellular communication processes.
+
+This powerful SDK empowers developers to seamlessly integrate cellular capabilities into their projects, allowing your projects to communicate over wide areas using cellular networks.
+
+One of the standout features of Pico LTE SDK is its comprehensive compatibility with popular backend services provided by Amazon Web Services (AWS), Azure, ThingSpeak, Slack, Scriptr.io and Telegram. This integration opens up a world of possibilities for leveraging the power of cloud-based services and enables seamless communication between embedded systems and the wider Internet ecosystem.  Pico LTE SDK is a game-changer for developers seeking to integrate cellular communication capabilities into their Raspberry Pi Pico-based projects.
+
+- **Easy Integration:** Enables seamless integration of cellular communication capabilities into embedded systems projects, specifically designed for the Sixfab Pico LTE board.
+- **Minimalistic Code:** Connecting to a built-in application requires less than 40 lines of code, reducing complexity and allowing for quick and efficient development.
+- **GPS Integration:** Easy-to-use GPS integration, enabling developers to incorporate location-based functionalities into their applications, leveraging cellular network-based positioning.
+- **Custom Application Modules:** With the Pico LTE SDK, developers have the flexibility to create their own application modules using the SDK. This feature allows for custom functionality tailored to specific project requirements.
+- **Versatile Protocols:** Pico LTE SDK simplifies the implementation of various protocols such as GPS, HTTPS, and MQTT. Developers can easily leverage these protocols for location-based services, secure web communication, and efficient machine-to-machine communication in IoT applications.
 
 ## Installation
-You can install the framework by cloning the repository to your local machine. You can also download the repository as a zip file and extract it to your local machine. After that, you can upload the `pico_lte` folder to your PicoLTE device's file system.
+
+The installation of the SDK is provided in detail and step-by-step on the ["Pico LTE SDK for MicroPython"](https://docs.sixfab.com/docs/sixfab-pico-lte-micropython-sdk) page.
+
+- Clone the repository to your local machine or download the repository as a zip and extract it on your local machine.
+
+- After that, upload the "[pico_lte](./pico_lte/)" folder to the root directory of your Pico LTE device. That's all.
+
 
 ## Usage
-Using the framework is pretty straightforward. A `main.py` file is needed to run in a MicroPython environment, therefore, please create a `main.py` script in your PicoLTE's file system. Import the framework with `from pico_lte.core import PicoLTE` line, and code your embedded project!
+Using the SDK is pretty straightforward. 
 
-**Note**: It is a must to have a tool to upload your `main.py` file or any example from our repository to your PicoLTE device. [Thonny IDE](https://thonny.org/) is a very common tool that has an easy GUI to perform this kind of operation. For a more compact and smaller size tool, we can recommend [Adafruit's Ampy](https://learn.adafruit.com/micropython-basics-load-files-and-run-code/install-ampy) to you.
+Import the SDK with `from pico_lte.core import PicoLTE` line, and code your IoT project!
 
-For further reference about installing or usage, please refer to our documentation page. Also, Sixfab Community Portal is available for your questions and recommendations.
+For more references on installation or usage, please refer to our [documentation page](https://docs.sixfab.com/docs/sixfab-pico-lte-micropython-sdk). By examining the [example codes](./examples/) provided on the platforms, you can delve into further details. You can connect various sensors to the Pico LTE, collect data on temperature, humidity, and air quality, and transmit this data over the cellular network using the Pico LTE SDK. 
+
+Additionally, the Sixfab Community is available for any questions or suggestions you may have.
 
 <p align="center">
-  <a aria-label="Documentation on Sixfab.com" href="https://docs.sixfab.com/" target="_blank">
+  <a aria-label="Documentation on Sixfab.com" href="https://docs.sixfab.com/docs/sixfab-pico-lte-introduction" target="_blank">
     <img alt="" src="https://img.shields.io/badge/Documentation-blue.svg?style=for-the-badge">
   </a>
-  <a aria-label="Community on Sixfab.com" href="https://community.sixfab.com/" target="_blank">
+  <a aria-label="Community on Sixfab.com" href="https://community.sixfab.com/c/sixfab-pico-lte/36" target="_blank">
     <img alt="" src="https://img.shields.io/badge/Community-blue.svg?style=for-the-badge">
   </a>
 </p>
 
 ## Configuration Files
 You can use a configuration file to increase maintainability of your embedded code. This file is named as `config.json` and stores necessary connection parameters which are designed for you to easily connect to the applications. You can find example files for each application and module in [CONFIGURATIONS.md](./CONFIGURATIONS.md) page.
 
-This file has to be in the root directory of the PicoLTE device's file system.
+This file has to be in the root directory of the Pico LTE device's file system.
+
+Please see the [Configure the Pico LTE SDK](https://docs.sixfab.com/docs/sixfab-pico-lte-micropython-sdk) page for more details.
 
 ## Contributing
 All contributions are welcome. You can find the guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md).
 
 ## License
-Licensed under the [MIT license](https://choosealicense.com/licenses/mit/).
+Licensed under the [MIT license](https://choosealicense.com/licenses/mit/).

examples/__basic__/blink_led.py

@@ -0,0 +1,14 @@
+"""
+
+Example code for blinking the USER LED.
+
+"""
+
+import machine
+import utime
+
+led = machine.Pin(22, machine.Pin.OUT)
+
+while True:
+    led.toggle()
+    utime.sleep(1)

examples/__basic__/button_controlled_led_toggle.py

@@ -0,0 +1,19 @@
+"""
+
+Example code for button controlled LED toggle.
+When the USER button is pressed, the light turns on. When the button is not pressed, the light turns off.
+
+"""
+
+import machine
+import utime
+
+led = machine.Pin(22, machine.Pin.OUT)  # We set up the pin to control the light.
+button = machine.Pin(21, machine.Pin.IN, machine.Pin.PULL_DOWN)  # We set up the pin for the button.
+
+while True:
+    if button.value() == 0:  # If the button is pressed (value is 0):
+        led.on()  # Turn on the light.
+    else:  # If the button is not pressed (value is 1):
+        led.off()  # Turn off the light.
+    utime.sleep(0.1)  # Wait for a short moment before checking again.

examples/__basic__/button_counter.py

@@ -0,0 +1,21 @@
+"""
+
+Example code for basic counter using USER button.
+Create a simple counter using a USER Button on the Pico LTE. 
+When the button is pressed, the counter increases by one, and the updated value is printed in the terminal.
+
+"""
+
+import machine
+import utime
+
+button = machine.Pin(21, machine.Pin.IN, machine.Pin.PULL_DOWN)
+counter = 0
+
+while True:
+    if button.value() == 0:
+        counter += 1
+        print("Counter:", counter)
+        while button.value() == 0:
+            pass  # Wait for the button to be released
+        utime.sleep(0.1)

examples/__basic__/led_brightness_with_pwm.py

@@ -0,0 +1,19 @@
+"""
+
+Example code for control USER LED brightness with PWM.
+
+"""
+
+import machine
+import utime
+
+led = machine.Pin(22, machine.Pin.OUT)  # Set up a pin to control the LED.
+pwm_led = machine.PWM(led)  # Initialize PWM (Pulse Width Modulation) for the LED.
+
+while True:
+    for duty_cycle in range(0, 65535, 1024):  # Increase LED brightness.
+        pwm_led.duty_u16(duty_cycle)  # Set the LED brightness level.
+        utime.sleep(0.01)  # Pause to observe the change.
+    for duty_cycle in range(64511, 0, -1024):  # Decrease LED brightness.
+        pwm_led.duty_u16(duty_cycle)  # Set the LED brightness level.
+        utime.sleep(0.01)  # Pause to observe the change.

examples/__basic__/neopixel_led_color_cycling.py

@@ -0,0 +1,32 @@
+"""
+
+Example code for color cycling on NeoPixel LED.
+
+"""
+
+import machine
+import neopixel
+import utime
+
+NUM_LEDS = 8
+pin = machine.Pin(15)
+np = neopixel.NeoPixel(pin, NUM_LEDS)
+
+def color_cycle(wait):
+    for i in range(NUM_LEDS):
+        np[i] = (255, 0, 0)  # Set LED color to red
+    np.write()
+    utime.sleep_ms(wait)  # Wait for a short duration
+    
+    for i in range(NUM_LEDS):
+        np[i] = (0, 255, 0)  # Set LED color to green
+    np.write()
+    utime.sleep_ms(wait)  # Wait for a short duration
+    
+    for i in range(NUM_LEDS):
+        np[i] = (0, 0, 255)  # Set LED color to blue
+    np.write()
+    utime.sleep_ms(wait)  # Wait for a short duration
+
+while True:
+    color_cycle(100)  # Call the color cycle function with a delay of 100 milliseconds

examples/__basic__/neopixel_led_rainbow_effect.py

@@ -0,0 +1,36 @@
+"""
+
+Example code for rainbow effect on NeoPixel LED.
+
+"""
+
+
+import machine
+import neopixel
+import utime
+
+NUM_LEDS = 8
+pin = machine.Pin(15)
+np = neopixel.NeoPixel(pin, NUM_LEDS)
+
+# Function for rainbow effect
+def rainbow_cycle(wait):
+    for j in range(255):
+        for i in range(NUM_LEDS):
+            rc_index = (i * 256 // NUM_LEDS) + j
+            np[i] = wheel(rc_index & 255)  # Set LED color using wheel function
+        np.write()
+        utime.sleep_ms(wait)
+
+def wheel(pos):
+    if pos < 85:
+        return (255 - pos * 3, pos * 3, 0)  # Red to Green transition
+    elif pos < 170:
+        pos -= 85
+        return (0, 255 - pos * 3, pos * 3)  # Green to Blue transition
+    else:
+        pos -= 170
+        return (pos * 3, 0, 255 - pos * 3)  # Blue to Red transition
+
+while True:
+    rainbow_cycle(20)  # Call the rainbow effect function with a delay of 20 milliseconds

examples/__basic__/qwiic.py

@@ -0,0 +1,27 @@
+"""
+
+Example code for SparkFun TMP102 Qwiic digital temperature sensor.
+
+"""
+
+import machine
+import time
+
+# Establishing the I2C connection. '0' corresponds to the I2C driver.
+# The 'SDA' and 'SCL' parameters respectively specify the SDA and SCL pins.
+# The 'freq' parameter determines the I2C communication speed.
+
+i2c = machine.I2C(0, scl=machine.Pin(13), sda=machine.Pin(12), freq=100000)
+tmp102_address = 0x48  # TMP102 I2C address (default set to 0x48).
+
+# Temperature reading function
+def read_temperature():
+    data = i2c.readfrom(tmp102_address, 2)  # Read two bytes of data
+    raw_temp = (data[0] << 8) | data[1]    # Get the raw data combined
+    temperature = (raw_temp >> 4) * 0.0625 # Convert raw data to temperature value
+    return temperature
+
+while True:
+    temperature = read_temperature()
+    print("Temperature: {:.2f} °C".format(temperature)) # Print the temperature value
+    time.sleep(1) # Slow down the loop by waiting 1 second