BLELocomotive.h

Go to the documentation of this file.

#pragma once
 
#include <Arduino.h>
 
#include "BLEHub.h"
#include "BLELocomotiveConfiguration.h"
#include "MCLedBase.h"
#include "MController.h"
 
class BLELocomotive
{
  public:
    BLELocomotive(BLELocomotiveConfiguration *config, MController *controller);
 
    // List of references to hubs inside this loco.
    std::vector<BLEHub *> Hubs;
 
    // Returns a boolean value indicating whether we are connected to all BLE hubs.
    bool AllHubsConnected();
 
    // Sets the given target speed for all motor channels for all hubs.
    void Drive(const int16_t minSpeed, const int16_t pwrPerc);
 
    // Triggers the given event for this loco.
    void TriggerEvent(MCTriggerSource source, std::string eventType, std::string eventId, std::string value);
 
    // Makes all channels on all hubs with lights attached blink for the given duration.
    void BlinkLights(int durationInMs);
 
    // Sets a new color for hubs that have an onboard LED.
    void SetHubLedColor(HubLedColor color);
 
    // If true, immediately sets the current speed for all channels on all hubs to zero and makes all loco lights blink.
    // If false, releases the emergency brake, returning the loco to normal operations.
    void SetEmergencyBrake(const bool enabled);
 
    // Returns the loco name.
    std::string GetLocoName();
 
    // Returns the loco address.
    uint GetLocoAddress();
 
    // Returns the number of hubs in the loco.
    uint GetHubCount();
 
    // Returns the hub at the given index.
    BLEHub *GetHub(uint index);
 
  private:
    // Initialized the leds inside this loco.
    // void initLights();
 
    // Initialized the hubs inside this loco.
    void initHubs();
 
    void handleConnectCallback(bool connected);
 
    // If true, immediately sets the current speed for all channels on all hubs to zero and makes all loco lights blink.
    // If false, releases the manual brake, returning the loco to normal operations.
    void setManualBrake(const bool enabled);
 
    // Returns a reference to a hub by its address.
    BLEHub *getHubByAddress(std::string address);
 
    // Returns a list of references to functions of the given type configured for this loco.
    // std::vector<MCFunctionBinding *> getFunctions(MCFunction f);
 
    // Returns a list of references to leds inside this loco.
    std::vector<MCLedBase *> _espLeds;
 
    // Reference to the configuration of this loco.
    BLELocomotiveConfiguration *_config;
 
    // Reference to the controller controling this loco.
    MController *_controller;
};