CodeCell Software Guide

The CodeCell is a versatile, penny-sized module that is perfect for DIY robotics, wearables, and IoT projects. It features an ESP32-C3 Wi-Fi & BLE module, and a USB-C port for both programming and battery charging. Designed for all makers, the CodeCell comes with a built-in light sensor and an optional 9-axis IMU motion sensor. To make programming even easier, the CodeCell library provides a wide array of functions for initializing, reading, and managing sensors and power.

Let's explore the CodeCell library and its functionalities to understand how to get the most out of this tiny but powerful board!

Initializing CodeCell

The first step in using the CodeCell is to initialize it. This is done using the `myCodeCell.Init()` function, which allows you to specify the sensors you want to enable.

Available Macros:

LIGHT - Enables Light Sensing.
MOTION_ACCELEROMETER - Enables Accelerometer Sensing.
MOTION_GYRO - Enables Gyroscope Sensing.
MOTION_MAGNETOMETER - Enables Magnetometer Sensing.
MOTION_LINEAR_ACC - Enables Linear Acceleration Sensing.
MOTION_GRAVITY - Enables Gravity Sensing.
MOTION_ROTATION - Enables Rotation Sensing.
MOTION_ROTATION_NO_MAG - Enables Rotation Sensing without Magnetometer.
MOTION_STEP_COUNTER - Enables Walking Step Counter.
MOTION_STATE - Enables Motion State Detection.
MOTION_TAP_DETECTOR - Enables Tap Detector.
MOTION_ACTIVITY - Enables Motion Activity Recognition.

You can combine multiple macros using the `+` operator to initialize multiple sensors at once.

Managing Power

The `myCodeCell.Run()` function is crucial for power management. This function should be called within the `loop()` function to handle battery status and ensure optimal power usage.

Function Behavior:

The function returns `true` every 100ms, which can be used for time-based operations.
It controls the onboard LED to indicate different power states:

Red Blinking (Blinking 10 times) - Battery voltage below 3.3V, entering Sleep Mode.
Green LED (Breathing Animation) - Powered by battery
Blue LED (Static) - Battery is Charging
Blue LED (Breathing Animation) - Fully charged and ready for operation.

Reading Sensor Data

After initializing the sensors, you can read their data using various functions provided by the library. Here's a quick rundown of the available functions:

Light Sensor Functions:

Light_ProximityRead() - Reads the proximity value from the light sensor.
Light_WhiteRead() - Reads the white light intensity from the light sensor.
Light_AmbientRead() - Reads the ambient light intensity from the light sensor.

Motion Sensor Functions:

Motion_AccelerometerRead(float &x, float &y, float &z) - Reads acceleration data along the x, y, and z axes.
Motion_GyroRead(float &x, float &y, float &z) - Reads rotational velocity data along the x, y, and z axes.
Motion_MagnetometerRead(float &x, float &y, float &z) - Reads magnetic field strength data along the x, y, and z axes.
Motion_GravityRead(float &x, float &y, float &z) - Reads gravity vector data along the x, y, and z axes.
Motion_LinearAccRead(float &x, float &y, float &z) - Reads linear acceleration data along the x, y, and z axes.
Motion_TapRead(uint16_t &x) - Reads the number of taps detected.
Motion_StepCounterRead(uint16_t &x) - Reads the number of steps counted.
Motion_RotationRead(float &roll, float &pitch, float &yaw) - Reads angular rotational data (roll, pitch, yaw).
Motion_RotationNoMagRead(float &roll, float &pitch, float &yaw) - Reads angular rotational data without using the magnetometer.
Motion_StateRead(uint16_t &x) - Reads the current state (e.g., On Table, Stationary, Motion).
Motion_ActivityRead(uint16_t &x) - Reads the current activity (e.g., Driving, Walking, Running).

Example Usage:

Sleep, Power-Saving, Diagnostic & LED Functions

The CodeCell includes several functions to manage sleep and power-saving modes:

WakeUpCheck() - Checks the wake-up reason of the device. If the device wakes up from a timer event, it returns `true`; otherwise, it returns `false`
Sleep(uint16_t sleep_sec) - Puts the device into deep sleep mode for a specified duration in seconds. It configures the necessary pins and sensors for low power consumption before entering sleep mode.
USBSleep(bool cable_polarity) - Manages the device's sleep mode when the battery level is low or when the device is charging via USB power. It shuts down the application and prepares the device for sleep to allow reprogramming if needed.
PrintSensors() - Prints the current readings from all initialized sensors to the serial monitor. This function is especially useful for debugging and data logging.
BatteryRead() - This function reads and returns the battery voltage when the USB-C port is disconnected.
LED_Breathing(uint32_t rgb_color_24bit) - This function is used in the Run() handler to control the onboard LED & create a breathing effect with a specific color. The `rgb_color_24bit` parameter is a 24-bit color value representing the RGB color.
LED(uint8_t r, uint8_t g, uint8_t b) - This function sets the color of the onboard addressable LED using the RGB model where `r`, `g`, and `b` are 8-bit values representing the red, green, and blue components of the color. Each component ranges from 0 to 255.

The Next Step

Download the CodeCell Arduino Library from the Library Manager to get started with multiple examples that showcase how these functions are used. Explore the full capabilities of CodeCell and start building your next innovative project today!