Skip to main content

Documentation Index

Fetch the complete documentation index at: https://bytebeam.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

You can additionally configure the BytebeamArduino via begin method. This would be helpful to customize the SDK as per your requirements.

​
Provisioning Configuration

As long as the file system is supported by the device, you can pick any of the following file systems for device provisioning.
  • SPIFFSProvisioning
  • LITTLEFSProvisioning
  • FATFSProvisioning
Default Configuration inside the SDK are as follows,
ArchFile SytemFile Name
ESP32SPIFFS/device_config.json
ESP8266LITTLEFS/device_config.json
You can override the default configurations as follows,
  • Provision your device with the required configurations.
  • Specify the same configurations in your sketch via begin method.
Before moving further make sure you have the selected file system partition (say SPIFFS). For this to ensure, you can select the partition table setting under Tools section. See Tools > Partition Scheme within the Arduino IDE. 

// using spiffs file system
Bytebeam.begin(BytebeamArduino::SPIFFS_FILE_SYSTEM, "/my_device_config.json");

// using littlefs file system
Bytebeam.begin(BytebeamArduino::LITTLEFS_FILE_SYSTEM, "/my_device_config.json");

// using fatfs file system
Bytebeam.begin(BytebeamArduino::FATFS_FILE_SYSTEM, "/my_device_config.json");

​
Debug Configuration

We have implemented the various log levels inside the BytebeamArduino and with this you can control the SDK logging as per your requirement. Default log level is BytebeamLogger::LOG_WARN inside the SDK. Note: We recommend going for BytebeamLogger::LOG_INFO log level while prototyping your sketch. 

// debug level : none
Bytebeam.begin(BytebeamArduino::SPIFFS_FILE_SYSTEM, "/my_device_config.json", BytebeamLogger::LOG_NONE);

// debug level : error
Bytebeam.begin(BytebeamArduino::SPIFFS_FILE_SYSTEM, "/my_device_config.json", BytebeamLogger::LOG_ERROR);

// debug level : warn
Bytebeam.begin(BytebeamArduino::SPIFFS_FILE_SYSTEM, "/my_device_config.json", BytebeamLogger::LOG_WARN);

// debug level : info
Bytebeam.begin(BytebeamArduino::SPIFFS_FILE_SYSTEM, "/my_device_config.json", BytebeamLogger::LOG_INFO);

// debug level : debug
Bytebeam.begin(BytebeamArduino::SPIFFS_FILE_SYSTEM, "/my_device_config.json", BytebeamLogger::LOG_DEBUG);

// debug level : trace
Bytebeam.begin(BytebeamArduino::SPIFFS_FILE_SYSTEM, "/my_device_config.json", BytebeamLogger::LOG_TRACE);