microbit-dal/inc/MicroBit.h

#ifndef MICROBIT_H
#define MICROBIT_H

#include "mbed.h"

#include "MicroBitConfig.h"  
#include "MicroBitHeapAllocator.h"
#include "MicroBitPanic.h"
#include "ErrorNo.h"
#include "MicroBitCompat.h"
#include "MicroBitComponent.h"
#include "ManagedType.h"
#include "ManagedString.h"
#include "MicroBitImage.h"	
#include "MicroBitFont.h"
#include "MicroBitEvent.h"
#include "DynamicPwm.h"
#include "MicroBitI2C.h"
#include "MESEvents.h"

#include "MicroBitButton.h"
#include "MicroBitPin.h"
#include "MicroBitCompass.h"
#include "MicroBitAccelerometer.h"
#include "MicroBitThermometer.h"
#include "MicroBitMultiButton.h"

#include "MicroBitSerial.h"
#include "MicroBitIO.h"
#include "MicroBitDisplay.h"

#include "MicroBitFiber.h"
#include "MicroBitMessageBus.h"

#include "ble/BLE.h"
#include "ble/services/DeviceInformationService.h"
#include "MicroBitDFUService.h"
#include "MicroBitEventService.h"
#include "MicroBitLEDService.h"
#include "MicroBitAccelerometerService.h"
#include "MicroBitMagnetometerService.h"
#include "MicroBitButtonService.h"
#include "MicroBitIOPinService.h"
#include "MicroBitTemperatureService.h"
#include "ExternalEvents.h"

// MicroBit::flags values
#define MICROBIT_FLAG_SCHEDULER_RUNNING         0x00000001
#define MICROBIT_FLAG_ACCELEROMETER_RUNNING     0x00000002
#define MICROBIT_FLAG_DISPLAY_RUNNING           0x00000004
#define MICROBIT_FLAG_COMPASS_RUNNING           0x00000008

// MicroBit naming constants
#define MICROBIT_NAME_LENGTH                    5
#define MICROBIT_NAME_CODE_LETTERS              5

// Random number generator
#define NRF51822_RNG_ADDRESS            0x4000D000


// mbed pin assignments of core components.
#define MICROBIT_PIN_SDA                P0_30
#define MICROBIT_PIN_SCL                P0_0

#if CONFIG_ENABLED(MICROBIT_DBG)
extern Serial pc;
#endif

/**
  * Class definition for a MicroBit device.
  *
  * Represents the device as a whole, and includes member variables to that reflect the components of the system.
  */
class MicroBit
{                                  
    private:
    
    void                    seedRandom();
    uint32_t                randomValue;
  
    public:
    
    // Map of device state.
    uint32_t                flags;

    // Periodic callback
    Ticker                  systemTicker;

    // I2C Interface
    MicroBitI2C             i2c;  
    
    // Serial Interface
#if CONFIG_DISABLED(MICROBIT_DBG)
    MicroBitSerial          serial;   
#endif    

    // Array of components which are iterated during a system tick
    MicroBitComponent*      systemTickComponents[MICROBIT_SYSTEM_COMPONENTS];
    
    // Array of components which are iterated during idle thread execution, isIdleCallbackNeeded is polled during a systemTick.
    MicroBitComponent*      idleThreadComponents[MICROBIT_IDLE_COMPONENTS];

    // Device level Message Bus abstraction
    MicroBitMessageBus      MessageBus;     
    
    // Member variables to represent each of the core components on the device.
    MicroBitDisplay         display;
    MicroBitButton          buttonA;
    MicroBitButton          buttonB;
    MicroBitMultiButton     buttonAB;    
    MicroBitAccelerometer   accelerometer;
    MicroBitCompass         compass;
    MicroBitThermometer     thermometer;

    //An object of available IO pins on the device
    MicroBitIO              io;
    
    // Bluetooth related member variables.
    BLEDevice                       *ble;
    MicroBitDFUService              *ble_firmware_update_service;
    
    /**
      * Constructor. 
      * Create a representation of a MicroBit device as a global singleton.
      * @param messageBus callback function to receive MicroBitMessageBus events.
      *
      * Exposed objects:
      * @code 
      * uBit.systemTicker; //the Ticker callback that performs routines like updating the display.
      * uBit.MessageBus; //The message bus where events are fired.
      * uBit.display; //The display object for the LED matrix.
      * uBit.buttonA; //The buttonA object for button a.
      * uBit.buttonB; //The buttonB object for button b.
      * uBit.resetButton; //The resetButton used for soft resets.
      * uBit.accelerometer; //The object that represents the inbuilt accelerometer
      * uBit.compass; //The object that represents the inbuilt compass(magnetometer)
      * uBit.io.P*; //Where P* is P0 to P16, P19 & P20 on the edge connector
      * @endcode
      */
    MicroBit();  

    /**
      * Post constructor initialisation method.
      * After *MUCH* pain, it's noted that the BLE stack can't be brought up in a 
      * static context, so we bring it up here rather than in the constructor.
      * n.b. This method *must* be called in main() or later, not before.
      *
      * Example:
      * @code 
      * uBit.init();
      * @endcode
      */
    void init();

    /**
     * Derives the friendly name for this device, autogenerated from our hardware Device ID.
     */
    void deriveName();

    /**
     * Return the friendly name for this device.
     *
     * @return A string representing the friendly name of this device.
     */
    ManagedString getName();

    /**
     * Return the serial number of this device.
     *
     * @return A string representing the serial number of this device.
     */
    ManagedString getSerial();

    /**
      * Will reset the micro:bit when called.
      *
      * Example:
      * @code 
      * uBit.reset();
      * @endcode
      */
    void reset();

    /**
      * Delay for the given amount of time.
      * If the scheduler is running, this will deschedule the current fiber and perform
      * a power efficent, concurrent sleep operation.
      * If the scheduler is disabled or we're running in an interrupt context, this
      * will revert to a busy wait. 
      * 
      * @note Values of 6 and below tend to lose resolution - do you really need to sleep for this short amount of time?
      *
      * @param milliseconds the amount of time, in ms, to wait for. This number cannot be negative.
      * @return MICROBIT_OK on success, MICROBIT_INVALID_PARAMETER milliseconds is less than zero. 
      *
      * Example:
      * @code 
      * uBit.sleep(20); //sleep for 20ms
      * @endcode
      */
    int sleep(int milliseconds);

    /**
      * Generate a random number in the given range.
      * We use the NRF51822 in built random number generator here
      * TODO: Determine if we want to, given its relatively high power consumption!
      *
      * @param max the upper range to generate a number for. This number cannot be negative
      * @return A random, natural number between 0 and the max-1. Or MICROBIT_INVALID_PARAMETER if max is <= 0.
      *
      * Example:
      * @code 
      * uBit.random(200); //a number between 0 and 199
      * @endcode
      */
    int random(int max);

    /**
      * Period callback. Used by MicroBitDisplay, FiberScheduler and I2C sensors to
      * provide a power efficient sense of time.
      */
    void systemTick();
    
    /**
      * System tasks to be executed by the idle thread when the Micro:Bit isn't busy or when data needs to be read.
      */
    void systemTasks();

    /**
      * add a component to the array of system components which invocate the systemTick member function during a systemTick 
      *
      * @param component The component to add.
      * @return MICROBIT_OK on success. MICROBIT_NO_RESOURCES is returned if further components cannot be supported.
      */
    int addSystemComponent(MicroBitComponent *component);
    
    /**
      * remove a component from the array of system components
      * @param component The component to remove.
      * @return MICROBIT_OK on success. MICROBIT_INVALID_PARAMETER is returned if the given component has not been previous added.
      */
    int removeSystemComponent(MicroBitComponent *component);
    
    /**
      * add a component to the array of of idle thread components.
      * isIdleCallbackNeeded is polled during a systemTick to determine if the idle thread should jump to the front of the queue
      * @param component The component to add.
      * @return MICROBIT_OK on success. MICROBIT_NO_RESOURCES is returned if further components cannot be supported.
      */
    int addIdleComponent(MicroBitComponent *component);
    
    /**
      * remove a component from the array of idle thread components
      * @param component The component to remove.
      * @return MICROBIT_OK on success. MICROBIT_INVALID_PARAMETER is returned if the given component has not been previous added.
      */
    int removeIdleComponent(MicroBitComponent *component);

    /**
      * Determine the time since this MicroBit was last reset.
      *
      * @return The time since the last reset, in milliseconds. This will result in overflow after 1.6 months.
      * TODO: handle overflow case.
      */
    unsigned long systemTime();
    
    /**
      * Determine the version of the micro:bit runtime currently in use.
      *
      * @return A textual description of the currentlt executing micro:bit runtime.
      * TODO: handle overflow case.
      */
    char *systemVersion();

    /**
      * Triggers a microbit panic where an infinite loop will occur swapping between the panicFace and statusCode if provided.
      * 
      * @param statusCode the status code of the associated error. Status codes must be in the range 0-255.
      */
    void panic(int statusCode = 0);

};

// Definition of the global instance of the MicroBit class.
// Using this as a variation on the singleton pattern, just to make
// code integration a little bit easier for third parties.
extern MicroBit uBit;

//
// BLE callback when an active GATT session with another device is terminated.
// Used to reset state and restart advertising ourselves.
//
void bleDisconnectionCallback(Gap::Handle_t handle, Gap::DisconnectionReason_t reason);

// Entry point for application programs. Called after the super-main function
// has initialized the device and runtime environment.
extern "C" void app_main();


#endif