Skip to content

FastBee System Features ​

API Reference: FastBee provides RESTful APIs organized into device management (/api/device), peripheral management (/api/peripherals), rule execution (/api/periph-exec), protocol configuration (/api/protocol), and system management (/api/system). All API calls require Session/Cookie authentication and return JSON data. See individual module docs and source code under network/handlers/.

This directory contains documentation for each feature module in the FastBee device Web console.

Documentation List ​

ModuleDocumentDescription
Dashboarddashboard.mdReal-time device status, memory/WiFi/uptime
Device Configdevice-config.mdDevice name, firmware version, system settings
Network Confignetwork-config.mdWiFi STA/AP, custom local domain, and static IP; Ethernet/4G only with build support
Hardware & Environmentsedition-comparison.mdRelease matrix, partitions, chip adaptation and runtime feature state
Peripheralsperipheral-management.mdAdd/edit/delete peripherals, type descriptions
PeriphExecperiph-exec-management.mdAutomation rule orchestration, trigger/action config
Rule Scriptrule-script.mdCommand script syntax, variables, execution engine
Configuration Backupfile-management.mdSelective import/export in Device Configuration and optional file APIs for custom builds
Device Logsdevice-log.mdLog levels, real-time viewing, clearing

Feature Architecture ​

The FastBee Web console runs on the ESP32 built-in HTTP server with these core pages:

  • Dashboard (home): Device runtime status overview
  • Device Config: System-level parameter management
  • Network Config: WiFi connection and network mode management; supported environments can enable Ethernet or 4G
  • Peripherals: Hardware peripheral add and management
  • PeriphExec: Automation rule orchestration and management
  • Protocols: MQTT/Modbus protocol configuration
  • Management: Logs when the corresponding feature is active; configuration import/export is under Device Configuration

Login is required for management APIs. Page visibility and API availability require compiled AND userEnabled AND budgetPassed AND NOT runtimeDisabled, plus any feature dependencies shown by Feature Config; hardware boundaries are listed in Hardware and Environments.

FastBee | fastbee.cn