Logbot Setup SDK for Flutter

Service used inside Logbot's devices to:

• Setup and gather informations about the device
• Retrieves and personalize configurations about the device and its network system
• Setup and gather informations about associated services like vpn, firewall and supervisor
• Exposing a web interface in order to visualize and interact with all the previous points

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: 2.0.0
• Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://logbot.cloud/

Requirements

Dart 2.17 or later

Installation & Usage

Add the dependencies from pub.dev:

dependencies:
  lb_auth:
  lb_setup:

lb_auth is always required to make authorized calls to the APIs. To use the SDK on you application see the example below:

/// Remember to call LogbotSetup.init() after ensureInitialized()
Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await LogbotSetup.init();
  runApp(const MyApp());
}

import 'package:lb_auth/lb_auth.dart';
import 'package:lb_setup/lb_setup.dart';

class Example {
  
  Future<void> run() async {
    /// Initialize Logbot SDK by logging in with Logbot Credentials
    await LogbotAuth.init(LogbotCredentials(
      username: username,
      password: password,
      clientId: clientId,
      clientSecret: clientSecret,
    ));
    /// Starts the Logbot Discovery to search for local devices
    await LogbotDiscovery.startDiscovery();
    /// Starts the background service to retrieve device status every minute
    /// (needed to read device status from cache)
    LogbotStateManager.start();
    /// Now you can use every API included on the SDK
    /// for example:
    WifiConfig? response = await LogbotSetup.network.getWifiConfig();
  }
}

Tests

To run all tests:

flutter test

Documentation for API Endpoints

All URIs are relative to https://devices.logbotiot.cloud

Documentation For Models

• AccessPointConfig
• AccessPointIPv4
• AccessPointStatus
• BluetoothConfig
• BluetoothStatus
• ConnectionAP
• ConnectionEth
• ConnectionStatus
• ConnectionWifi
• ConnectionWifiScan
• DeviceBriefing
• DeviceConfiguration
• DeviceInfo
• DevicePosition
• DeviceStatus
• Dns
• Error
• GeolocatorConfig
• GeolocatorStatus
• HPSStatus
• IpV4
• LanConfig
• LanStatus
• Led
• LedTest
• License
• LicenseToken
• ModemBearer
• ModemConfig
• ModemConnection
• ModemGsm
• ModemM3GPP
• ModemNetwork
• ModemNetwork3gpp
• ModemNetworkModemBearers
• ModemNetworkBearerIp4Config
• ModemNetworkBearersProperties
• ModemNetworkBearersStats
• ModemNetworkModem
• ModemNetworkSim
• ModemSim
• ModemStatus
• NetworkConfig
• NetworkStatus
• Position3gppLacCi
• PositionNMEA
• PositionNMEAGGA
• PositionNMEAGSA
• PositionNMEARMC
• PositionNMEAVTG
• PositionRAW
• Resources
• ResourcesCpu
• ResourcesCpuTemperature
• ResourcesMemory
• SecurityWifi
• StatisticsStatus
• SupervisorApplication
• SupervisorContainer
• SupervisorData
• SupervisorDevice
• SupervisorEngine
• SupervisorImage
• SupervisorService
• SupervisorVpn
• SupervisorVpnVpn
• Version
• VpnConfig
• VpnConfigIpv4
• VpnStatus
• WanConfig
• WanStatus
• WifiConfig
• WifiScan
• WifiStatus

Author

Logbot SRL info@logbot.cloud