Giter VIP home page Giter VIP logo

pico_lte_micropython-sdk's Introduction

PicoLTE SDK for MicroPython

an embedded framework to make easier cellular connections

version applications stars

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

The installation of the SDK is provided in detail and step-by-step on the "Pico LTE SDK for MicroPython" 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" folder to the root directory of your Pico LTE device. That's all.

Usage

Using the SDK is pretty straightforward.

Import the SDK with from pico_lte.core import PicoLTE line, and code your IoT project!

For more references on installation or usage, please refer to our documentation page. By examining the example codes 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.

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 page.

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 page for more details.

Contributing

All contributions are welcome. You can find the guidelines in CONTRIBUTING.md.

License

Licensed under the MIT license.

pico_lte_micropython-sdk's People

Contributors

aydanurkayalar avatar bisguzar avatar electricalgorithm avatar ensarkarabudak avatar mehmetcy avatar ozgurkaraaslan avatar selengalp avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

pico_lte_micropython-sdk's Issues

Add authentication example / hint in http documentation.

When scrolling through the documentation for HTTP(s) connection, it took me a while and some digging on GitHub to find out how to connect to an endpoint using basic authentication. I thought adding the username password to config.json is sufficient.

BUT, you need to run picoLTE.http.set_auth() additionally to set authentication.

picoLTE = PicoLTE()

picoLTE.network.register_network()
picoLTE.http.set_context_id()
picoLTE.network.get_pdp_ready()
picoLTE.http.set_auth()
picoLTE.http.set_server_url()

debug.info("Sending a POST request.")

Maybe this can be added to the documentation, since one will usually use authentication with an public endpoint

https://docs.sixfab.com/docs/pico-lte-http-request-to-web-server

register_network() not responding when registering from Belgium/Europe

Hi,
I have registered and activated my PicoLTE asset on the SixFab.com (and provided the required payment to get a positive balance).

I was trying to get the MQTT example at work but I got a connection issue on the Network.

>>> from pico_lte.utils.status import Status
>>> from pico_lte.core import PicoLTE
>>> from pico_lte.common import debug
>>> picoLTE  = PicoLTE()

Now, the red LED turns ON, the blue LED blinks shortly every 2 seconds.

Then, I call the register_network() which doens't return.

>>> picoLTE.network.register_network()

Some additional tests

I did located the debug module but have not been able to get more information from it.

>>> picoLTE.network.get_apn()
{'status': 0, 'response': ['+CGDCONT: 1,"IPV4V6","super","0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0",0,0,0', 'OK'], 'value': 'super'}

>>> picoLTE.network.get_operator_information()
{'status': 0, 'response': ['+COPS: 0', 'OK'], 'value': '0'}

>>> picoLTE.network.base.get_all_cells()
{'response': 'timeout', 'status': 2}

I noticed that get_all_cells() takes time to respond (about 1 or 2 minutes) before returning a timeout.
It seems that the QueCTEL module cannot get registered on the mobile network.

Is there an easy way to spy the atcom messages exchange with the QueCTEL module ?

Cheers
Dominique

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.