1. Introduction

Welcome to the introduction chapter of our documentation. This section will help you get familiar with the project, understand key concepts, and guide you through the initial setup process.

1.1. Overview

This introduction provides essential information to help you get started quickly. You’ll learn about:

• Basic concepts and terminology

• Installation and setup

• First steps and common workflows

• Where to find additional resources

For more detailed information, please refer to the specific sections in the documentation.

Contents:

• 1.1.1. Command Line Documentation - Device
  • 1.1.1.1. Understanding RustiQ IOT commands and processes
  • 1.1.1.2. First launch - and first steps
  • 1.1.1.3. Command line help
• 1.1.2. Admin API - Command References
  • 1.1.2.1. AdminEmbedded commands (core admin)
  • 1.1.2.2. RTCTime (service “time”)
  • 1.1.2.3. Powermanagement (service “power”)
  • 1.1.2.4. Wifiservice commands (service “wifi”)
  • 1.1.2.5. Transfers service commands (service “transfer”)
  • 1.1.2.6. eink commands (service eink)
  • 1.1.2.7. Scheduler commands (service “scheduler”)
  • 1.1.2.8. Monitoring commands (service “monitoring”)
  • 1.1.2.9. NetworkManager commands (service “networkmanager”)
  • 1.1.2.10. Bluetooth(BT), serial connection
  • 1.1.2.11. GPIO Service, (service “gpio”)
• 1.1.3. Logs and monitoring
• 1.1.4. Services Diagram
• 1.1.5. Standard Services Blueprint and Responsibilities
  • 1.1.5.1. Supervisor
  • 1.1.5.2. Wifi
  • 1.1.5.3. Monitoring
  • 1.1.5.4. Power Management
  • 1.1.5.5. RTC Time
  • 1.1.5.6. Scheduler
  • 1.1.5.7. Transfert
  • 1.1.5.8. Network Manager
• 1.1.6. Available services

1.2. Services Description

This section describes the services that are available in the project.

Contents:

• 1.2.1. Admin Web - 1.0
  • 1.2.1.1. Configuration
  • 1.2.1.2. Detailed commands
• 1.2.2. Ble Admin 1.0
  • 1.2.2.1. Configuration
  • 1.2.2.2. Implementation
• 1.2.3. EInk service - 1.0
  • 1.2.3.1. Configuration
  • 1.2.3.2. Detailed commands
• 1.2.4. Gallery service plugin - 1.0
  • 1.2.4.1. Configuration
  • 1.2.4.2. Detailed commands
  • 1.2.4.3. Sample for using the gallery using the admincli / admin_web commands
• 1.2.5. Monitoring service - 1.0
• 1.2.6. Powermanagement 1.0 service
  • 1.2.6.1. Configuration
• 1.2.7. RtcTimeService 1.0 service
• 1.2.8. Scheduler service-1.0
  • 1.2.8.1. Using Cron expression
  • 1.2.8.2. Scheduler implementation
  • 1.2.8.3. Scheduler behaviour
• 1.2.9. Supervisor 1.0 service implementation
  • 1.2.9.1. Configuration
• 1.2.10. Transfer Service 1.0 Implementation
  • 1.2.10.1. Store Concept
  • 1.2.10.2. Service Configuration
  • 1.2.10.3. Store Implementations
  • 1.2.10.4. Methods
  • 1.2.10.5. Usage Examples
• 1.2.11. WiFi Service 1.0
  • 1.2.11.1. Features
  • 1.2.11.2. Implementation Details
  • 1.2.11.3. Configuration