sgwireless.com
Home
Getting Started
Unboxing your Starter Kit
Introducing VS CtrlR
Installing VS CtrlR Plugin
Configuring F1 Starter Kit for CtrlR Plugin on your PC
Zero-Touch Provisioning (ZTP)
Regional Coverage
Provisioning Steps
Next Steps
Manual Provisioning for F1
Prerequisites
Provisioning Steps
Part 1 – Configure your network profile
Part 2 – Add your F1 Starter Kit
Part 3 – Configure your F1 Starter Kit Network
Part 4 – Deploy to your F1 Starter Kit
Your First Sensor Data
Add your CAP/T Sensor
Link your CAP/T Sensor to your F1 Starter Kit
Map your CAP/T Sensor data
Next Steps
Your First F1 Code
Resetting the Device
Hard reset
Soft reboot
Hardware
F1 Smart Module
Introduction
Key Features
Order Information
General Features
Feature Specifications
Pinout & Pin Definitions
Pin Definitions
Electrical Specifications
Rating & Operating Conditions
WiFi
Bluetooth
LTE
LoRa(WAN)
Module Interface
Power Management
Memory Allocation
Mechanical Specifications
Module Dimensions
Recommended PCB Landing Pattern
Recommended Soldering Profile
MicroPython
Device Programming via UART
Module-supported Libraries
Product Packaging
Revision History
Certification
F1 Starter Kit
Introduction
Varieties
What Makes the F1 Starter Kit Unique
What to Expect in Development
Features
Connectivity
Microprocessor
Memory
Peripherals
On-board Peripherals
Arduino UNO Shield Compatible Expansion
Power
Starter Kit Overview
Block Diagram
Starter Kit Topology — Top View
Starter Kit Topology — Bottom View
Pinout & Pin Definitions
Pin Definitions
Board Operation
Software
Ctrl Web Platform
Projects
Project Components
Add Project
Switch Project
Edit Project
Delete Project
Device Templates
Fields
Dasboard Layout
Associated Devices
Software Releases
Automation
Devices
Firmware Update
File Management
Next Steps
Networks
Manage Network Profiles
Manage Device Network Settings
Sensors
Add a Sensor to Ctrl
Update Sensor Information
Remove a Sensor from Ctrl
Link Sensor to a Device
Unlink Sensor from a Device
Dashboards & Widgets
Value Widget
Boolean Widget
Data Log Table Widget
Bar Chart Widget
Line Chart Widget
Gauge Widget
Map Widget (coming soon)
Arranging Your Widgets
Integrations
Webhook
AWS IoT Core
Azure IoT Hub
Account Settings
Update Personal Account Settings
Update Organization Settings
CtrlR Visual Studio Plugin
Introducing VS CtrlR
Installing VS CtrlR Plugin
Configuring F1 Starter Kit for CtrlR Plugin on your PC
Programming with CtrlR
Sending Commands Through Visual Studio Terminal
Creating a project in CtrlR
Running code on F1 Starter Kit before uploading
Uploading code to your F1 Starter Kit
Programming References
Application
CTRL API Documentation
Contents
Fields
Configuration
Activate ctrl with the configuration pasted from the CTRL platform (under device/provisioning)
Connection
Miscellaneous
Examples
Deprecated API
Logging Library
Contents
Introduction
Architecture
C API — Subsystem and Component Definitions
C API — Logging Macros
C API — Color Macros
C API — Filtering Functions
C API — Dynamic Registration
MicroPython API —
logs
Module
MicroPython API — Registration
MicroPython API — Logging Functions
MicroPython API — Filtering
Log Output Format
Kconfig Options
Capacity Limits
Example — C Component
Example — MicroPython
Network Interfaces
LoRa API Documentation
Contents
Initialization
LoRa Modes
LoRa Test stub
LoRa WAN API Documentation
Available LoRa WAN APIs Summary
LoRa WAN Stats
Setting LoraWAN parameters
Device commissioning
Join
Sending data
Receiving Data
LoRa Ports
Callbacks
lora.callback()
Duty cycle operations
RX listening
Adaptive Data Rate (ADR)
TX Airtime —
lora.tx_airtime()
Last Network RX Timestamp —
lora.last_rx_at()
LoRa RAW API Documentation
Available LoRa RAW APIs Summary
LoRa Raw Settings
Modifying Radio Parameters
Setting LoRa RAW user Callback
Send (TX) Data
Receive (RX) Data
RX Continuous Mode
Continuous TX Wave mode
LoRa Callback System
Contents
Introduction
LoRa Events
LoRa Callback Generic Interface
Example LoRa-RAW
Example LoRa-WAN
Remarks
lte Module - C Implementation
Usage
Methods
Constants
Error Handling
Implementation Notes
Advanced Usage
Logging and Debugging
Constructors
class LTE.LTE(…)
Methods
lte.__init__([carrier=’standard’, cid=1, mode=None, baudrate=115200, debug=None])
lte.deinit([reset=False])
lte.attach([apn=None, type=’IP’, cid=None, band=None, bands=None])
lte.isattached()
lte.is_attached()
lte.detach()
lte.connect([cid=None])
lte.isconnected()
lte.is_connected()
lte.disconnect()
lte.send_at_cmd(cmd, [timeout=-1, wait_ok_error=False, check_error=False])
lte.reset()
lte.pause_ppp()
lte.resume_ppp()
lte.mode([new_mode=None])
lte.power_on([wait_ok=True])
lte.power_off([force=False])
lte.check_sim_present()
lte.check_power()
lte.print_pretty_response(rsp, [flush=False, prefix=None])
lte.return_pretty_response(resp)
lte.read_rsp([size=None, timeout=-1, wait_ok_error=False, check_error=False])
lte.check_ppp()
lte.ifconfig()
lte.imei()
lte.iccid()
Constants
Peripherals & System
RGB-LED ( WS2812B )
Contents
Introduction
RGB LED Functions
Non-Volatile Storage (NVS) Interface
Contents
Introduction
NVS Statistics
NVS Query
NVS Key-Value Operations
System Information
Contents
Introduction
Board Information
Version Information
Other Information
IO Expander Interface (PCAL6408A)
Contents
Introduction
PCAL6408A Features
MicroPython Interface
Complete Example
C/C++ Interface
Hardware Connection
Troubleshooting
Register Map
Fuel-Gauge ( BQ27421 )
Contents
Introduction
Fuel-Gauge Functions
Battery Info Fields
Example
CAN API Documentation
Contents
Functions
Example
eFuse Interface
Contents
Introduction
eFuse Read Functions
eFuse Layout
Example
FUOTA Module - Firmware Update Over The Air
Features
Resume Behaviour (NB-IoT / LTE-M)
API Reference
Usage Patterns
Memory Usage
Network Requirements
Security
Troubleshooting
Implementation Details
Future Enhancements
See Also
SafeBoot Feature
Contents
Introduction
Entering Safeboot
Safeboot Configurations
Safeboot APIs
System Inspection
Contents
Introduction
Memory Dump
sys_inspect.dump_memory()
Peripherals Power
MicroPython Libraries
Standard Libraries
Hardware & System Libraries
SG Wireless Extensions
Further Reading
Tutorials & Examples
Basic Tutorials
REPL
Resetting the Device
REPL control commands
Boot modes
Sleep
Basic sleep
Power saving
Wake up reason
Print
RGB LED
rgbled.color()
rgbled.heartbeat()
rgbled.decoration()
rgbled._color
GPIO
Output
Input
Hardware Tutorials
ADC
I2C
Drivers for the BH1750FVI
Timers
Timer
Network Tutorials
WiFi
Connected by Devices (Act as an AP)
Connecting to a Router (Act as a Device)
Using an external antenna
BLE
LoRa Examples
LoRaWAN with OTAA
LoRaWAN with ABP
LoRa-MAC (Raw LoRa)
LTE Examples
General remarks
SG SIM card
LTE Connectivity check
LTE Mode check and LTE Mode switching
Custom APN setting
Event-driven connection
Contact
License
SG Wireless
Tutorials & Examples
Basic Tutorials
Edit on GitHub
Basic Tutorials
REPL
Sleep
Print
RGB LED
GPIO
v: v1.4.0
Versions
v1.4.0 (latest)
v1.3.0
Downloads
PDF
External Links
sgwireless.com
GitHub
