Strober.cpp

/*******************************************************************************
* Copyright (c) 2018 Elhay Rauper
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted (subject to the limitations in the disclaimer
* below) provided that the following conditions are met:
*
*     * Redistributions of source code must retain the above copyright notice,
*     this list of conditions and the following disclaimer.
*
*     * Redistributions in binary form must reproduce the above copyright
*     notice, this list of conditions and the following disclaimer in the
*     documentation and/or other materials provided with the distribution.
*
*     * Neither the name of the copyright holder nor the names of its
*     contributors may be used to endorse or promote products derived from this
*     software without specific prior written permission.
*
* NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
* THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
* IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/


#include "Strober.h"


/* Predefined notes arrays. Odd indexes are async delays (in   */ 
/* milliseconds), pair indexes are notes to play (0 - led off, */
/* 1 - led on)                                                 */
const uint16_t Strober::SLOW_BLINK_ARR[SLOW_BLINK_SIZE] = {1, 500, 0, 500};
const uint16_t Strober::FAST_BLINK_ARR[FAST_BLINK_SIZE] = {1, 300, 0, 300};
const uint16_t Strober::STROBE_BLINK_ARR[STROBE_BLINK_SIZE] = {1, 70, 0, 70, 1, 70, 0, 70, 1, 70, 0, 950};

Strober::Strober(uint16_t pin) 
{ 
  index_ = 0; 
  pin_ = pin;
}


/* Goal: Set notes for play() method. */
/* Param: LedNotes enum               */
void Strober::setNotes(uint16_t* notes, size_t notes_size)
{
  if (notes_ != notes)
  {
    reset();
    notes_ = notes;
    notes_size_ = notes_size;
    timer_.reset();
  }
}

void Strober::reset() 
{
   index_ = 0; 
   timer_.reset();
}

void Strober::setNotes(Notes notes)
{
  uint16_t * selected_notes = nullptr;
  size_t selected_notes_size = 0;
  switch (notes)
  {
    case BLINK_SLOW:
      selected_notes = (uint16_t*)SLOW_BLINK_ARR;
      selected_notes_size = SLOW_BLINK_SIZE;
      break;
    case BLINK_FAST:
      selected_notes = (uint16_t*)FAST_BLINK_ARR;
      selected_notes_size = FAST_BLINK_SIZE;
      break;
    case STROBE:
      selected_notes = (uint16_t*)STROBE_BLINK_ARR;
      selected_notes_size = STROBE_BLINK_SIZE;
      break;
  }
  setNotes(selected_notes, selected_notes_size);
}

/**************************************************************
* Goal: Play notes (blink led accordingly). This method must
* be invoked in loop for continuouse play.
* Param: pin of led to blink
**************************************************************/
void Strober::play()
{
  if (index_ < notes_size_)
  {
    if (timer_.finished())
    {
      if (index_ % 2 == 0)
      {
        if (notes_[index_] == 0)
          digitalWrite(pin_, LOW);
        else
          digitalWrite(pin_, HIGH);
      }
      else
        timer_.start(notes_[index_]);
      index_++;
    }
  }
  else
    index_ = 0;
}