DOCSEARCHbyAlgolia
Submit Docs

LuatOS Documentation

repository·master·Indexed 20 days ago

https://github.com/openluat/luatos

An operating system optimized for Holysion IoT modules and hardware, featuring a powerful Lua engine for rapid business logic implementation. The ecosystem includes the Flash Abstraction Layer (FAL) for managing Flash devices and partitions, a high-performance interface for FTDI/Bridgetek EVE2, EVE3, and EVE4 graphics controllers (FT81x and BT81x series), and a C11-based emulator core (gbc) for GB and GBC cartridges.

Tokens
179K
Snippets
465
Records
898
Agent score
70%

What's inside LuatOS

  1. Overview of codec demo functionalities

    master

    The module/Air8201/demo/codec/ directory contains several demonstration scripts:

    • codec_mp3_to_pcm: Decodes an MP3 file into PCM data and performs streaming playback using exaudio.
    • codec_g711_pcm: Demonstrates G711 codec functionality by encoding a PCM file to G711, then decoding and playing it back.
    • codec_pcm_to_amr: Encodes a PCM file into AMR format and plays it using exaudio. It uses mono mode and maintains the original PCM file's sampling rate and bit depth.

  2. Overview of AirCAMERA_1031 Demo Functions

    master

    The AirCAMERA_1031 demo showcases several core capabilities for camera-based IoT applications using LuatOS. The demo is structured into several functional modules:

    • Main Entry Module (main.lua): Orchestrates the overall application flow.
    • WIFI Connection Module (netdrv_wifi.lua): Handles network connectivity.
    • Photo Upload Module (http_upload_file.lua): Core business logic for capturing photos and uploading them via HTTP.
    • Video Upload Module (video_http_post.lua): Core business logic for recording video and uploading it via HTTP.
    • RTMP Streaming Module (rtmp_app.lua): Handles real-time video streaming via RTMP.

    Hardware Environments

    Depending on the specific feature being demonstrated, different hardware configurations are used:

    • Photo Upload: Specific hardware setup for capturing and sending images.
    • Video Upload: Specific hardware setup for recording and sending video files.
    • RTMP Streaming: Specific hardware setup for live streaming.

  3. Overview of TLSF Memory Allocator

    master

    TLSF (Two-Level Segregated Fit) is a memory allocator implementation designed for high performance and low fragmentation. It is suitable for embedded systems where predictable allocation timing is critical.

    Key Features

    • O(1) Complexity: malloc, free, realloc, and memalign operations all have constant time complexity.
    • Low Overhead:
      • Per-allocation overhead is only 4 bytes.
      • Per-pool management overhead is approximately 3kB.
    • Dynamic Pools: Supports adding and removing memory pool regions on the fly.
    • Small Footprint: Compiles to only a few kB of code and data.

  4. Overview of AirCAMERA_1030 DEMO functions

    master

    The AirCAMERA_1030 DEMO demonstrates how to use the AirCAMERA_1030 accessory to capture photos or record videos and upload them to a server using the httpplus extension library.

    Core Modules:

    • main.lua: The main entry point.
    • take_photo_http_post.lua: Captures a photo and uploads it to a server.
    • video_http_post.lua: Records a video and uploads it to a server.
    • rtmp_app.lua: Handles RTMP live streaming.
    • netdrv_wifi.lua: Manages WIFI connectivity.

    Important Constraints:

    • Mutual Exclusion: You can only enable one of the following modules at a time: take_photo_http_post.lua, video_http_post.lua, or rtmp_app.lua.
    • Server Configuration: The demo uses air32.com, which is no longer in use. You must modify the upload URL to your own server address or use the excloud extension library to upload to the LuatOS IOT platform (uploadtest.luatos.com).

  5. Overview of ndk_perf_guest performance suite

    master

    The ndk_perf_guest is a performance testing suite designed to compare the execution speed of a pure-Lua implementation of small algorithms against an NDK guest-C implementation.

    Key Concept: The suite measures NDK guest C performance versus Lua, not host C versus Lua. To ensure a fair comparison, the guest C implementation is loaded as a flat RV32IMA binary inside the NDK interpreter, and host-ABI shortcuts (such as CSR 0x230 / 0x231 for MD5/CRC32) are explicitly forbidden in the guest code.

    Tested Algorithms:

    • FNV-1a 32-bit (Arithmetic/Bit twiddling)
    • CRC32 IEEE (Arithmetic/Bit twiddling)
    • Base64 encode (String/Encoding)
    • MD5 (Crypto hash)
    • Heapsort int32 (Sort/Search)

  6. Overview of Audio Functional Modules for Air780EHV

    master

    The Air780EHV audio demo provides several functional modules for playback and recording.

    Playback Modules:

    • play_file.lua: Plays local MP3, WAV, or AMR files.
    • play_tts.lua: Text-to-Speech (TTS) synthesis (Chinese only).
    • play_stream.lua: Streaming playback of PCM audio data.
    • http_stream_play.lua: HTTP streaming playback (PCM, AMR, MP3, WAV) using the new audio framework.
    • http_download_play.lua: Downloads and plays audio files (MP3, AMR, PCM); files > 200KB require SD card storage.

    Recording Modules:

    • record_amr_file.lua: Records audio in AMR format (default: /sd/record.amr).
    • record_pcm_file.lua: Records audio in PCM format (default: /sd/record.pcm).

    Important Limitation: Recording and playback cannot be performed simultaneously.

  7. Overview of the Air8101 FTP Demo Project

    master

    This demo project demonstrates FTP client functionality on the Air8101 module using LuatOS. It covers connecting to an FTP server, uploading files, downloading files, and implementing a retry mechanism for robust operations.

    Project Structure

    • main.lua: The main entry point of the program.
    • ftp_up_download.lua: The core functional script that performs FTP operations (upload, download, directory manipulation).
    • netdrv_device.lua: Network driver configuration file. It allows you to choose between different network interface types (Single WiFi, Single SPI Ethernet, Multi-network, or PC Simulator).
    • netdrv/: A directory containing the specific network driver implementations for the different interface types.

  8. Overview of the SIP Demo Project

    master

    The SIP Demo project for Air8000 demonstrates Session Initiation Protocol (SIP) capabilities across various networking scenarios. It provides testing frameworks for single and multi-network card configurations, including 4G, WiFi, and Ethernet.

    Supported Test Scenarios

    • Scenario 1: 4G single network card connectivity test.
    • Scenario 2: WiFi single network card connectivity test.
    • Scenario 3: Ethernet single network card connectivity test.
    • Scenario 4: Multi-network card combined call testing.

  9. Overview of AirCAMERA_1030 DEMO functionality

    master

    The AirCAMERA_1030 DEMO demonstrates various camera-related capabilities on the Air8101 platform. The demo is structured into several functional modules:

    • Main Entry (main.lua): The central orchestration module.
    • WIFI Connection (netdrv_wifi.lua): Handles network connectivity.
    • Photo Upload (http_upload_file.lua): Core business logic for capturing and uploading photos via HTTP.
    • Video Upload (video_http_post.lua): Core business logic for recording and uploading video via HTTP.
    • RTMP Streaming (rtmp_app.lua): Business logic for RTMP live streaming.

    Users can view captured photos on the 合宙Iot设备管理平台 (Luatos IoT Device Management Platform).

  10. Overview of Air8201G GNSS Application Scenarios

    master

    This demo uses the exgnss library on the Air8201G board to implement three distinct GNSS application modes:

    1. Normal Mode:

      • Connects to a server via TCP (tcp_client_main).
      • Configures GNSS parameters and enables the GNSS application.
      • Uses a 60s timer to trigger positioning.
      • Once positioning is successful, GNSS is turned off, RMC data (latitude/longitude) is retrieved, and the data is sent to the server.

    2. Low Power Mode:

      • Connects to a server via TCP.
      • Configures GNSS and starts a 60s timer.
      • Every 60s, the module enters Normal Mode to perform positioning.
      • After successful positioning and data transmission, the module enters a low-power state.

    3. PSM+ Mode:

      • Upon wakeup, configures GNSS and enables the application.
      • Once positioning is successful, GNSS is turned off.
      • Retrieves RMC data, concatenates it with wakeup information, and connects to the server to send the data.
      • Configures a sleep/wakeup timer, enters flight mode, and then enters PSM+ mode.

  11. Overview of the errdump Demo module

    master

    The errdump demo allows developers to capture and report exception logs (errdump) from the device. It supports four primary reporting methods. Note: You cannot use automatic reporting and manual reading simultaneously.

    Reporting Methods

    1. Automatic reporting to IoT platform: Uses auto_dump_air_srv.lua to send logs to the official LuatOS server.
    2. Automatic reporting to a custom UDP server: Uses auto_dump_udp_srv.lua. Requirement: The UDP server must respond with a capital OK upon receiving the log.
    3. Manual reading via UART: Uses uart_app.lua to transmit manually read logs through the serial port.
    4. Manual reading via TCP: Uses the errdump_tcp folder to send manually read logs to a TCP server.

    Core Components

    • main.lua: The main entry point where you select which feature to use.
    • netdrv_device.lua: Configures the network driver. You can choose between 4G, WiFi, SPI Ethernet, or multiple network interfaces.
    • errdump_read.lua: Module for manually reading exception logs.

  12. Overview of the AirTalk Intercom System

    master

    The AirTalk demo provides a complete implementation of an intercom (walkie-talkie) system for the Air8000 module. It manages group contact lists, intercom status monitoring, and audio device control.

    Core Components

    • main.lua: The program entry point that initializes the AirTalk system.
    • talk.lua: The core business logic module for intercom operations.
    • audio_drv: Handles audio device initialization and control using the exaudio extension library.
    • netdrv_device.lua: Network driver configuration. It supports four network configurations: single 4G, single WiFi, single SPI Ethernet, or multi-network setups.