https://github.com/acceleronix/simpli-kit-python-sample
Python sample code for Acceleronix SIMPLI-Kit hardware
https://github.com/acceleronix/simpli-kit-python-sample
Last synced: about 1 month ago
JSON representation
Python sample code for Acceleronix SIMPLI-Kit hardware
- Host: GitHub
- URL: https://github.com/acceleronix/simpli-kit-python-sample
- Owner: Acceleronix
- License: mit
- Created: 2025-01-27T08:45:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-16T10:06:56.000Z (9 months ago)
- Last Synced: 2025-09-16T12:38:16.464Z (9 months ago)
- Language: Python
- Homepage:
- Size: 38.4 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SIMPLI Kit Python Sample
This repository contains Python sample code for working with Acceleronix SIMPLI-Kit hardware, providing a complete solution for IoT sensor data collection and cloud connectivity.
## Project Structure
The project is organized into the following components:
- **Main Application:** Entry point that initializes all services with intelligent SIM management
- **Drivers:** Hardware interfaces for various sensors (SHTC3, LPS22HB, TCS34725, ICM20948)
- **Extensions:** Services for GNSS, LBS, sensors, buzzer control, fan control, SIM management, and Acceleronix cloud connectivity
- **Libraries:** Utility modules for I2C communication, threading, logging, etc.
## Configuration
Please update the `config.json` file with your product credentials created in [Acceleronix IoT Developer Center](https://core.acceleronix.io/).
```json
{
"QTH_PRODUCT_KEY": "your_product_key",
"QTH_PRODUCT_SECRET": "your_product_secret",
"QTH_SERVER": "mqtt://iot-south.acceleronix.io:1883"
}
```
## Hardware Components
### Supported Sensors
| Sensor | Description | Capabilities |
|--------|-------------|--------------|
| SHTC3 | Temperature & humidity sensor | High-accuracy environmental monitoring |
| LPS22HB | Barometric pressure sensor | Pressure and temperature readings |
| TCS34725 | RGB color sensor | Color detection and light sensing |
| ICM20948 | 9-axis motion sensor | Accelerometer, gyroscope, and magnetometer |
### Services
#### Core Services
- **GNSS Service:** GPS location tracking and position reporting
- **LBS Service:** Location approximation using cellular tower information
- **Sensor Service:** Collection and aggregation of sensor data
- **Qth Client:** Cloud connectivity and data transmission
#### Hardware Control Services
- **Buzzer Service:** Buzzer control with GPIO management and hot-plug support
- ON/OFF control via cloud commands
- Hardware detection and fallback simulation
- Status reporting and monitoring
- **Fan Service:** PWM-based fan control with multiple speed modes
- Fan switch control (ON/OFF)
- Speed modes: Low (1), Medium (2), High (3)
- PWM hardware detection and simulation fallback
#### System Services
- **SIM Service:** Intelligent SIM card management
- Automatic detection of physical SIM and vSIM
- Priority-based selection (physical SIM first, vSIM fallback)
- Real-time SIM status monitoring
- Automatic switching capabilities
## Enhanced Features
### Intelligent SIM Management
The application now includes automatic SIM card detection and management:
- **Priority-based Selection**: Automatically detects and uses physical SIM first, falls back to vSIM if needed
- **Hot-plugging Support**: Monitors SIM status and handles SIM card changes dynamically
- **Network Optimization**: Ensures optimal connectivity with automatic switching capabilities
### Hardware Extension Support
New modular hardware services provide:
- **Buzzer Control**: GPIO-based buzzer management with hardware detection
- **Fan Control**: PWM-based fan speed control with multiple modes
- **Hot-plug Detection**: Services gracefully handle hardware availability changes
## Firmware Development
### Base Firmware
The `base_firmware/` directory contains the QuecPython base firmware required for building custom firmware with this sample code:
- **EG912UGLAAR05A01M08_TEST0220.zip**: QuecPython base firmware for EG912U-GLAA module
- Developers can merge this base firmware with the Python code in this repository to generate custom firmware
- This enables creating standalone firmware images that include both the base system and your application code
To build custom firmware, developers should:
1. Use the base firmware from the `base_firmware/` directory
2. Combine it with the Python application code from this repository
3. Follow the official QuecPython documentation for combining firmware and scripts: [QPYcom Merge Tutorial](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/qpycom-merge.html)
## Getting Started
### 1. Get to Know Your SIMPLI-Kit
The SIMPLI-Kit by Acceleronix lets you connect effortlessly to the Acceleronix Asset Management SaaS, enabling quick cloud service demos with zero setup hassle. This guide will walk you through using the SIMPLI-Kit to explore platform features seamlessly.
You can visit this [webpage](https://www.acceleronix.io/products/simpli-kit) to access more details about the product.
#### 1.1 What is SIMPLI-Kit?
The SIMPLI-Kit is your gateway to exploring the Acceleronix Asset Management SaaS. Built on the QuecPython **EG912U-GLAA** evaluation board, it’s designed for fast, plug-and-play connectivity.
##### 1.1.1 Compatible Modules
| Product Line | Module |
|--|--|
|LTE Standard | EG912U-GL |
The SIMPLI-Kit supports the following module:
##### 1.1.2 Unboxing Your SIMPLI-Kit
Here’s what your SIMPLI-Kit looks like out of the box:
##### 1.1.3 What’s Inside the Box?
See the components included in your SIMPLI-Kit package:
##### 1.1.4 Boards at a Glance
Here’s a look at the boards of the SIMPLI-Kit:
- EG912U-GL QuecPython board:
##### 1.1.6 Included Accessories
Your SIMPLI-Kit comes with the following accessories:
**Accessories List**
| Item | Description | |
|--|--|-- |
|USB-C Cable | For powering and connecting the SIMPLI-Kit | 1 |
|USB Memory Stick | 32GB storage with preloaded resources | 1 |
|Welcome Card | Includes quick start instructions | 1 |
|Antenna | YF0028AA Cellular (4G/3G/2G) Antenna | 1 |
|Acrylic Case | Protective case for the SIMPLI-Kit | 1 |
### 2. Set Up Your SIMPLI-Kit
Let’s get started! Follow these steps to power up your SIMPLI-Kit:
1. Connect the SIMPLI-Kit to your laptop or a power bank using the provided USB-C cable.
2. The device will power on, automatically connect to the internet via vSIM, and link to the Acceleronix Asset Management SaaS.
>**Note**: The SIMPLI-Kit automatically enables vSIM and includes a 20MB/month data plan for 6 months for testing purposes.
### 3. Connect to the Asset Management SaaS
The Asset Management SaaS platform, developed by Acceleronix, offers a comprehensive solution for specialized industries. It covers the entire business process from TSL model feature definition to SaaS platform management and mobile app device control.
This Asset Management SaaS platform enables device operation for users, allowing dynamic analysis of hardware data based on the TSL model. It integrates various sensors, such as water quality, temperature, humidity, light, and carbon dioxide, to suit different scenarios. Features include real-time data viewing, historical operating curves, data aggregation, and device mapping with track playback for location-based devices.
#### 3.1 Log in with Demo Account
Access the Asset Management SaaS Application using the demo account below:
- **Website URL**: [https://eueam.acceleronix.io/login](https://eueam.acceleronix.io/login)
- **Account Name** and **Password**: Acceleronix will email you after your purchase. Please contact .
#### 3.2 Find Your Device
1. Navigate to **Device management > Device List**.
2. Locate the IMEI code on the white sticker of your SIMPLI-Kit.
3. Search for the IMEI code in the platform. If the status shows **Online**, your device is successfully connected!
#### 3.3 Check Device Location (LBS)
1. Click **Details** in the Device List to open the device details.
2. Go to the **Location** tab to see the LBS location data.
> **Note**: Location updates every 30 minutes. To refresh manually, click the refresh button in the App control panel, then reload the page to see the updated location.
### 4. Control Your Device with the Wonderfree App
#### 4.1 Obtain the Binding QR Code
1. In the Acceleronix Asset Management SaaS, go to **Device management > Device List > Device Information**.
2. Hover over the QR code icon in the Basic Information section to display the Device QR code.
> **Note**: You can also find the QR code on the bottom of the SIMPLI Kit device.
#### 4.2 Download the App and Add Your Device
1. Download the **Wonderfree** app from the app store:
- **iOS**: [App Store](https://apps.apple.com/gb/app/wonderfree/id6450249586)
- **Android**: [Google Play](https://play.google.com/store/search?q=wonderfree&c=apps&hl=en_CA&gl=US) or Xiaomi, Vivo, OPPO app galleries.
- More details, please check: [App | Acceleronix](https://core.acceleronix.io/app)
2. Register a new account with your email and log in.
3. Tap **Add Device** in the app, then scan the QR code from the Asset Management SaaS to add your SIMPLI-Kit. It will appear on the app’s home page.
#### 4.3 View and Manage Sensor Data
1. When your device is online, tap it in the Wonderfree app to access the control panel.
2. View real-time sensor and LBS location data from your SIMPLI-Kit.
3. To update sensor data or LBS location, tap the refresh button in the top-right corner of the control panel.
### 5. Access Acceleronix Developer Center
Please visit to register an account and login to explore the Acceleronix Developer Center features.
You can follow this [tutorial](https://iot-docs.acceleronix.io/quickStart/register.html) to get started.
### 6. OTA Update Steps
#### 6.1 Update Version Configuration
Edit `code/config.json` and set `APP_version` to the new version:
```json
{
"APP_version": "V1.0.1"
}
```
#### 6.2 Package Upgrade Files
From the `code/` directory, execute the **tar** command to package the script file and generate the upgrade package `ota.tar.gz.`. Here is the example:
```bash
tar -zcvf ota.tar.gz ./extensions/sensor_service.py config.json
```
**Requirements:**
- Include `config.json` with updated `APP_version`
- Preserve directory structure (run from `code/` directory)
- Maintain relative file paths
#### 6.3 Create OTA Task
Create a new OTA task in the [Acceleronix Developer Platform](https://core.acceleronix.io/).
**Reference:** [QuecPython Script Upgrade](https://iot-docs.acceleronix.io/deviceDevelop/DeviceAccessPlan/cellular/QuecPython/example/ota/quecpython-example-02.html)
#### 6.4 Component Configuration
Set **Component Identifier** to `appota` in both:
- Version Package Management → "Verify Firmware"
- Upgrade Plan → "Add a Component"
## Developer Resources
For additional technical details, documentation, and advanced usage examples, visit the [Acceleronix Developer Portal](https://core.acceleronix.io/).
## Support
If you encounter any issues or have questions about this sample code, please contact [Acceleronix Support](mailto:support@acceleronix.io).