Revision 6:85ac8bf9955e, committed 2018-05-24

Comitter:

Shaun Kelsey

Date:

Thu May 24 14:45:27 2018 -0700

Parent:

5:795cffb6f01a

Commit message:

Add LEDStatus and EventStats

Changed in this revision

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Utilities/EventStats.cpp	Thu May 24 14:45:27 2018 -0700
@@ -0,0 +1,117 @@
+/***************************************************************************
+* Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
+*
+* Permission is hereby granted, free of charge, to any person obtaining a
+* copy of this software and associated documentation files (the "Software"),
+* to deal in the Software without restriction, including without limitation
+* the rights to use, copy, modify, merge, publish, distribute, sublicense,
+* and/or sell copies of the Software, and to permit persons to whom the
+* Software is furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included
+* in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+* OTHER DEALINGS IN THE SOFTWARE.
+*
+* Except as contained in this notice, the name of Maxim Integrated
+* Products, Inc. shall not be used except as stated in the Maxim Integrated
+* Products, Inc. Branding Policy.
+*
+* The mere transfer of this software does not imply any licenses
+* of trade secrets, proprietary technology, copyrights, patents,
+* trademarks, maskwork rights, or any other form of intellectual
+* property whatsoever. Maxim Integrated Products, Inc. retains all
+* ownership rights.
+****************************************************************************
+*/
+
+#include "EventStats.h"
+#include "Peripherals.h"
+
+EventStats::EventStats() :
+	single_evt(), all_evts()
+{
+	name = "";
+	report_period = 1000000;
+	num_evts = 0;
+	total_evt_time = 0;
+
+	evt_in_prog = false;
+}
+
+EventStats::EventStats(int report_period, const char* name) :
+	single_evt(), all_evts()
+{
+	if (name)
+		this->name = name;
+	else
+		this->name = "";
+
+	this->report_period = report_period;
+	num_evts = 0;
+	total_evt_time = 0;
+	evt_in_prog = false;
+
+}
+
+void EventStats::start()
+{
+	if (evt_in_prog) {
+		pr_debug("EventStats::start() called twice without calling EventStats::stop()!");
+	}
+
+
+	if (!num_evts)
+		all_evts.start();
+
+	single_evt.start();
+	evt_in_prog = true;
+
+}
+
+void EventStats::stop()
+{
+	if (!evt_in_prog) {
+		pr_debug("EventStats::stop() called before EventStats::start()!");
+	}
+
+	single_evt.stop();
+	num_evts++;
+	evt_in_prog = false;
+	total_evt_time += single_evt.read_us();
+	single_evt.reset();
+
+	int time_since_start = all_evts.read_us();
+	if (time_since_start > report_period) {
+		print_events(true);
+	}
+}
+
+void EventStats::print_events(bool reset)
+{
+	if (num_evts > 0) {
+		int time_since_start = all_evts.read_us();
+		int avg = total_evt_time / num_evts;
+
+		pr_debug("[Event (%s) hit %d times in %dus. Avg: %dus, Total: %dus\r\n",
+				name,
+				num_evts,
+				time_since_start,
+				avg,
+				total_evt_time);
+	} else {
+		pr_debug("Event (%s) has not yet occurred\r\n", name);
+	}
+
+	if (reset) {
+		num_evts = 0;
+		all_evts.reset();
+		total_evt_time = 0;
+	}
+}

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Utilities/EventStats.h	Thu May 24 14:45:27 2018 -0700
@@ -0,0 +1,68 @@
+/*******************************************************************************
+ * Author: Shaun Kelsey, shaun.kelsey@maximintegrated.com
+ * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+ * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * Except as contained in this notice, the name of Maxim Integrated
+ * Products, Inc. shall not be used except as stated in the Maxim Integrated
+ * Products, Inc. Branding Policy.
+ *
+ * The mere transfer of this software does not imply any licenses
+ * of trade secrets, proprietary technology, copyrights, patents,
+ * trademarks, maskwork rights, or any other form of intellectual
+ * property whatsoever. Maxim Integrated Products, Inc. retains all
+ * ownership rights.
+ *
+ ******************************************************************************/
+#ifndef _PLATFORM_EVENT_H
+#define _PLATFORM_EVENT_H
+
+
+#include "mbed.h"
+
+class EventStats
+{
+	public:
+		EventStats();
+		EventStats(int report_period, const char* name);
+
+		//Start an event
+		void start();
+
+		//Stop an event. If report_period time has passed, prints stats
+		void stop();
+
+		//Print out stats. Set report_period to < 0 if you want to call this manually
+		void print_events(bool reset);
+
+	private:
+
+		const char* name;
+		int report_period;
+		int num_evts;
+		int total_evt_time;
+
+		bool evt_in_prog;
+		Timer single_evt;
+		Timer all_evts;
+};
+
+
+#endif

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Utilities/LEDStatus.cpp	Thu May 24 14:45:27 2018 -0700
@@ -0,0 +1,127 @@
+/*******************************************************************************
+* Author: Shaun Kelsey, shaun.kelsey@maximintegrated.com
+* Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
+*
+* Permission is hereby granted, free of charge, to any person obtaining a
+* copy of this software and associated documentation files (the "Software"),
+* to deal in the Software without restriction, including without limitation
+* the rights to use, copy, modify, merge, publish, distribute, sublicense,
+* and/or sell copies of the Software, and to permit persons to whom the
+* Software is furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included
+* in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+* OTHER DEALINGS IN THE SOFTWARE.
+*
+* Except as contained in this notice, the name of Maxim Integrated
+* Products, Inc. shall not be used except as stated in the Maxim Integrated
+* Products, Inc. Branding Policy.
+*
+* The mere transfer of this software does not imply any licenses
+* of trade secrets, proprietary technology, copyrights, patents,
+* trademarks, maskwork rights, or any other form of intellectual
+* property whatsoever. Maxim Integrated Products, Inc. retains all
+* ownership rights.
+*******************************************************************************
+*/
+
+#include "LEDStatus.h"
+#include "Peripherals.h"
+
+LEDStatus::LEDStatus(PinName red, int rstate, PinName green, int gstate, PinName blue, int bstate):
+	rLED(red, rstate), gLED(green, gstate), bLED(blue, bstate), blinking(false), timer()
+{
+}
+
+void LEDStatus::set_state(int rstate, int gstate, int bstate)
+{
+	r_act = rstate;
+	g_act = gstate;
+	b_act = bstate;
+
+	if (!blinking) {
+		rLED = r_act;
+		gLED = g_act;
+		bLED = b_act;
+	}
+}
+
+void LEDStatus::solid()
+{
+	blinking = false;
+	rLED = r_act;
+	gLED = g_act;
+	bLED = b_act;
+
+	timer.stop();
+}
+
+void LEDStatus::blink(int ontime, int offtime, int nb)
+{
+	ont_us = 1000 * ontime;
+	offt_us = 1000 * offtime;
+	count = 1;
+	total = nb;
+	blinking = true;
+
+	rLED = r_act;
+	gLED = g_act;
+	bLED = b_act;
+	bs = true;
+
+	timer.reset();
+	timer.start();
+}
+
+void LEDStatus::blink(int period, float duty, int nb)
+{
+	ont_us = 1000 * period * duty;
+	offt_us = (1000 * period) - ont_us;
+	count = 1;
+	total = nb;
+	blinking = true;
+
+	rLED = r_act;
+	gLED = g_act;
+	bLED = b_act;
+	bs = true;
+
+	timer.reset();
+}
+
+bool LEDStatus::is_blinking()
+{
+	return blinking;
+}
+
+void LEDStatus::update()
+{
+	uint64_t time = timer.read_high_resolution_us();
+	uint64_t frame_time = time % (ont_us + offt_us);
+
+	if (bs && (frame_time > ont_us)) {
+		bs = false;
+		rLED = LED_OFF;
+		gLED = LED_OFF;
+		bLED = LED_OFF;
+		count++;
+
+	} else if (!bs && (frame_time <= ont_us)) {
+		bs = true;
+		rLED = r_act;
+		gLED = g_act;
+		bLED = b_act;
+
+		if (total > 0 && count >= total) {
+			blinking = false;
+			timer.stop();
+		}
+	}
+}

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Utilities/LEDStatus.h	Thu May 24 14:45:27 2018 -0700
@@ -0,0 +1,117 @@
+/*******************************************************************************
+* Author: Shaun Kelsey, shaun.kelsey@maximintegrated.com
+* Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
+*
+* Permission is hereby granted, free of charge, to any person obtaining a
+* copy of this software and associated documentation files (the "Software"),
+* to deal in the Software without restriction, including without limitation
+* the rights to use, copy, modify, merge, publish, distribute, sublicense,
+* and/or sell copies of the Software, and to permit persons to whom the
+* Software is furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included
+* in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+* OTHER DEALINGS IN THE SOFTWARE.
+*
+* Except as contained in this notice, the name of Maxim Integrated
+* Products, Inc. shall not be used except as stated in the Maxim Integrated
+* Products, Inc. Branding Policy.
+*
+* The mere transfer of this software does not imply any licenses
+* of trade secrets, proprietary technology, copyrights, patents,
+* trademarks, maskwork rights, or any other form of intellectual
+* property whatsoever. Maxim Integrated Products, Inc. retains all
+* ownership rights.
+*******************************************************************************
+*/
+#ifndef _LEDSTATUS_H_
+#define _LEDSTATUS_H_
+#include "mbed.h"
+
+class LEDStatus
+{
+public:
+
+	/** Create an LED_Status controller
+	 * 
+	 *  @param red PinName of red LED
+	 *  @param rstate Initial state of red LED
+	 *  @param green PinName of green LED
+	 *  @param gstate Initial state of green LED
+	 *  @param blue PinName of blue LED
+	 *  @param bstate Initial state of blue LED
+	 */
+	LEDStatus(PinName red, int rstate, PinName green, int gstate, PinName blue, int bstate);
+
+	/** Set the active state of each LED
+	 *
+	 *  @param rstate active state of red LED
+	 *  @param gstate active state of green LED
+	 *  @param bstate active state of blue LED
+	 */
+	void set_state(int rstate, int gstate, int bstate);
+
+	/** Set and keep the LEDs in their active state */
+	void solid();
+
+	/** Set the LEDs to toggle between their active state and their off state
+	 *
+	 *  @param ontime The amount of time (in milliseconds) to remain in the active state
+	 *  @param offtime The amount of time (in milliseconds) to remain off
+	 *  @param nb The number of times to blink before remaining in the off state
+	 *  				Set to -1 to blink indefinitely
+	 *
+	 */
+	void blink(int ontime, int offtime, int nb = -1);
+
+	/** Set the LEDs to toggle between their active state and their off state
+	 *
+	 *  @param period The period of each blink (in milliseconds)
+	 *  @param offtime The percentage of the period during which the LEDs will be in their active state
+	 *  @param nb The number of times to blink before remaining in the off state
+	 *  				Set to -1 to blink indefinitely
+	 */
+	void blink(int period, float duty, int nb = -1);
+
+	/** Get whether LEDState is in the blinking state
+	 */
+	bool is_blinking();
+
+	/** Called in main loop of program to advance the state of the class
+	 *  @detail Instead of using a Ticker and generating additional interrupts and overhead,
+	 *  		LEDStatus relies on update being called at a decent interval in order
+	 *  		to advance its interval time keeping and blink LEDs and the correct rate.
+	 *  		If only using solid() mode, update() does not need to be called.
+	 */
+	void update();
+
+private:
+
+	DigitalOut rLED;
+	DigitalOut gLED;
+	DigitalOut bLED;
+
+	int r_act;
+	int g_act;
+	int b_act;
+
+	bool blinking;
+	bool bs;
+	int count;
+	int total;
+
+	uint64_t ont_us;
+	uint64_t offt_us;
+
+	Timer timer;
+
+};
+
+#endif