/* This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * */ /** show the time on a LED strip * @file main.c * @author King Kévin * @date 2016 */ /* standard libraries */ #include // standard integer types #include // standard I/O facilities #include // standard utilities #include // standard streams #include // error number utilities #include // string utilities #include // mathematical utilities /* STM32 (including CM3) libraries */ #include // real-time control clock library #include // general purpose input output library #include // vector table definition #include // Cortex M3 utilities #include // interrupt utilities #include // external interrupt utilities #include // ADC utilities #include // real time clock utilities /* own libraries */ #include "global.h" // board definitions #include "usart.h" // USART utilities #include "usb_cdcacm.h" // USB CDC ACM utilities #include "led_ws2812b.h" // WS2812B LEDs utilities #include "rtc_ds1307.h" // Real Time Clock DS1307 utilities #include "rtc_dcf77.h" // DCF77 time receiver utilities /** use external RTC, else use internal RTC */ #define EXTERNAL_RTC false /** @defgroup main_flags flag set in interrupts to be processed in main task * @{ */ volatile bool button_flag = false; /**< flag set when board user button has been pressed/released */ volatile bool photoresistor_flag = false; /**< flag set when ambient luminosity is measured */ #if defined(EXTERNAL_RTC) && EXTERNAL_RTC #else volatile bool rtc_internal_tick_flag = false; /**< flag set when internal RTC ticked */ #endif /** @} */ /** @defgroup main_ticks ticks per time units * @note these are derived from TICKS_PER_SECOND * @note I have to use type variables because defines would be stored in signed integers, leading to an overflow it later calculations * @{ */ /** the number of ticks in one second (32768 divisor greater than 256*LED_WS2812B_LEDS/60) */ #if defined(EXTERNAL_RTC) && EXTERNAL_RTC #define TICKS_PER_SECOND (RTC_DS1307_SQUARE_WAVE_FREQUENCY/RTC_DS1307_SQUARE_WAVE_TICKS) #else #define TICKS_PER_SECOND 256 #endif /** number of ticks in one second */ const uint32_t ticks_second = TICKS_PER_SECOND; /** number of ticks in one minute */ const uint32_t ticks_minute = 60*TICKS_PER_SECOND; /** number of ticks in one hour */ const uint32_t ticks_hour = 60*60*TICKS_PER_SECOND; /** number of ticks in one midday (12 hours) */ const uint32_t ticks_midday = 12*60*60*TICKS_PER_SECOND; /** @} */ /** @defgroup photoresistor_adc ADC used to ambient luminosity * @{ */ #define PHOTORESISTOR_ADC_CHANNEL ADC_CHANNEL1 /**< ADC channel */ #define PHOTORESISTOR_PORT GPIOA /**< port on which the battery is connected */ #define PHOTORESISTOR_PORT_RCC RCC_GPIOA /**< timer port peripheral clock */ #define PHOTORESISTOR_PIN GPIO1 /**< pin of the port on which the battery is connected */ /** @} */ /** RGB values for the WS2812B clock LEDs */ uint8_t clock_leds[LED_WS2812B_LEDS*3] = {0}; /** user input command */ char command[32] = {0}; /** user input command index */ uint8_t command_i = 0; /** gamma correction lookup table (common for all colors) */ uint8_t gamma_correction_lut[256] = {0}; /** photo-resistor measurement of ambient luminosity */ volatile uint16_t photoresistor_value = 0; /** photo-resistor voltage for the minimum brightness */ #define PHOTORESISTOR_MIN 2.7 /** photo-resistor voltage for the maximum brightness */ #define PHOTORESISTOR_MAX 1.7 /** factor to dim LED of the clock, depending on the ambient luminosity */ float clock_brightness = 1; /** minimum LED brightness */ #define BRIGHTNESS_MIN 0.2 /** maximum LED brightness */ #define BRIGHTNESS_MAX 1.0 /** the factor to change the brightness */ #define BRIGHTNESS_FACTOR 0.1 int _write(int file, char *ptr, int len) { int i; // how much data has been sent static char newline = 0; // what newline has been sent if (file == STDOUT_FILENO || file == STDERR_FILENO) { for (i = 0; i < len; i++) { if (ptr[i] == '\r' || ptr[i] == '\n') { // send CR+LF newline for most carriage return and line feed combination if (newline==0 || (newline==ptr[i])) { // newline has already been detected usart_putchar_nonblocking('\r'); // send newline over USART usart_putchar_nonblocking('\n'); // send newline over USART cdcacm_putchar('\r'); // send newline over USB cdcacm_putchar('\n'); // send newline over USB newline = ptr[i]; // remember the newline } if (ptr[i] == '\n') { // line feed are always considered to end a line (the LF+CR combination is not supported to better support the others) newline = 0; // clear new line } } else { // non-newline character usart_putchar_nonblocking(ptr[i]); // send byte over USART cdcacm_putchar(ptr[i]); // send byte over USB newline = 0; // clear new line } } return i; } errno = EIO; return -1; } char* b2s(uint64_t binary, uint8_t rjust) { static char string[64+1] = {0}; // the string representation to return int8_t bit = LENGTH(string)-1; // the index of the bit to print string[bit--] = 0; // terminate string while (binary) { if (binary & 1) { string[bit--] = '1'; } else { string[bit--] = '0'; } binary >>= 1; } while (64-bit-1=0) { string[bit--] = '0'; } return &string[bit+1]; } /** switch off all clock LEDs * @note LEDs need to be set separately */ static void clock_clear(void) { // set all colors of all LEDs to 0 for (uint16_t i=0; i=LED_WS2812B_LEDS*256 || led_minute>=LED_WS2812B_LEDS*256) { // a calculation error occurred return; } // show hours and minutes on LEDs if (led_hour>led_minute) { // show hours in blue (and clear other LEDs) for (uint16_t led=0; led=0xff) { // full hours clock_leds[led*3+2] = 0xff; } else { // running hours clock_leds[led*3+2] = led_hour; } led_hour -= clock_leds[led*3+2]; } // show minutes in green (override hours) for (uint16_t led=0; led0; led++) { clock_leds[led*3+0] = 0; if (led_minute>=0xff) { // full minutes clock_leds[led*3+1] = 0xff; } else { // running minutes clock_leds[led*3+1] = led_minute; } led_minute -= clock_leds[led*3+1]; clock_leds[led*3+2] = 0; } } else { // show minutes in green (and clear other LEDs) for (uint16_t led=0; led=0xff) { // full minutes clock_leds[led*3+1] = 0xff; } else { // running minutes clock_leds[led*3+1] = led_minute; } led_minute -= clock_leds[led*3+1]; clock_leds[led*3+2] = 0; } // show hours in blue (override minutes) for (uint16_t led=0; led0; led++) { clock_leds[led*3+0] = 0; clock_leds[led*3+1] = 0; if (led_hour>=0xff) { // full hours clock_leds[led*3+2] = 0xff; } else { // running hours clock_leds[led*3+2] = led_hour; } led_hour -= clock_leds[led*3+2]; } } // don't show seconds on full minute (better for first time setting, barely visible else) if (time%ticks_minute==0) { return; } uint32_t led_second = (LED_WS2812B_LEDS*(256*(uint64_t)(time%ticks_minute)))/ticks_minute; // scale to LED brightnesses for seconds uint8_t brightness_second = led_second%256; // get brightness for seconds for last LED uint16_t second_led = (LED_WS2812B_LEDS*(time%ticks_minute))/ticks_minute; // get LED for seconds (we only use the last LED as runner instead of all LEDs as arc) // set seconds LED clock_leds[second_led*3+0] = brightness_second; //clock_leds[second_led*3+1] = 0; // clear other colors (minutes/hours indication) //clock_leds[second_led*3+2] = 0; // clear other colors (minutes/hours indication) // set previous seconds LED second_led = ((second_led==0) ? LED_WS2812B_LEDS-1 : second_led-1); // previous LED clock_leds[second_led*3+0] = 0xff-brightness_second; //clock_leds[second_led*3+1] = 0; // clear other colors (minutes/hours indication) //clock_leds[second_led*3+2] = 0; // clear other colors (minutes/hours indication) } /** set the LEDs * @details set the LED colors on WS2812B LEDs * @note WS2812B LED color values need to be transmitted separately */ static void clock_leds_set(void) { for (uint16_t i=0; i255 ? 512-i-1 : i); // get fade brightness for (uint8_t hour=0; hour<12; hour++) { // set all hour colors uint16_t led = LED_WS2812B_LEDS/12*hour; // get LED four hour mark clock_leds[led*3+0] = brightness; // set brightness clock_leds[led*3+1] = brightness; // set brightness clock_leds[led*3+2] = brightness; // set brightness } clock_leds_set(); // set the colors of all LEDs led_ws2812b_transmit(); // transmit set color // delay some time for the animation for (uint32_t j=0; j<40000; j++) { __asm__("nop"); } } } /** process user command * @param[in] str user command string (\0 ended) */ static void process_command(char* str) { // split command const char* delimiter = " "; char* word = strtok(str,delimiter); if (!word) { goto error; } // parse command if (0==strcmp(word,"help")) { printf("available commands:\n"); printf("DCF77 on|off\n"); printf("time [HH:MM:SS]\n"); #if defined(EXTERNAL_RTC) && EXTERNAL_RTC printf("date [YYYY-MM-DD]\n"); #endif } else if (0==strcmp(word,"DCF77")) { word = strtok(NULL,delimiter); if (!word) { goto error; } else if (0==strcmp(word,"on")) { rtc_dcf77_on(); // switch DCF77 on printf("DCF77 receiver switched on\n"); // notify user } else if (0==strcmp(word,"off")) { rtc_dcf77_off(); // switch DCF77 off printf("DCF77 receiver switched off\n"); // notify user } else { goto error; } } else if (0==strcmp(word,"time")) { word = strtok(NULL,delimiter); if (!word) { #if defined(EXTERNAL_RTC) && EXTERNAL_RTC printf("current time: %02u:%02u:%02u\n", rtc_ds1307_read_hours(), rtc_ds1307_read_minutes(), rtc_ds1307_read_seconds()); // get and print time from external RTC #else printf("current time: %02lu:%02lu:%02lu\n", rtc_get_counter_val()/ticks_hour, (rtc_get_counter_val()%ticks_hour)/ticks_minute, (rtc_get_counter_val()%ticks_minute)/ticks_second); // get and print time from internal RTC #endif } else if (strlen(word)!=8 || word[0]<'0' || word[0]>'2' || word[1]<'0' || word[1]>'9' || word[3]<'0' || word[3]>'5' || word[4]<'0' || word[4]>'9' || word[6]<'0' || word[6]>'5' || word[7]<'0' || word[7]>'9') { // time format is incorrect goto error; } else { #if defined(EXTERNAL_RTC) && EXTERNAL_RTC if (!rtc_ds1307_write_hours((word[0]-'0')*10+(word[1]-'0')*1)) { printf("setting hours failed\n"); } else if (!rtc_ds1307_write_minutes((word[3]-'0')*10+(word[4]-'0')*1)) { printf("setting minutes failed\n"); } else if (!rtc_ds1307_write_seconds((word[6]-'0')*10+(word[7]-'0')*1)) { printf("setting seconds failed\n"); } else { rtc_ds1307_ticks = rtc_ds1307_read_hours()*ticks_hour+rtc_ds1307_read_minutes()*ticks_minute+rtc_ds1307_read_seconds()*ticks_second; // set also internal time rtc_ds1307_oscillator_enable(); // be sure the oscillation is enabled printf("time set\n"); } #else rtc_set_counter_val(((word[0]-'0')*10+(word[1]-'0')*1)*ticks_hour+((word[3]-'0')*10+(word[4]-'0')*1)*ticks_minute+((word[6]-'0')*10+(word[7]-'0')*1)*ticks_second); // set time in internal RTC counter printf("time set\n"); #endif } #if defined(EXTERNAL_RTC) && EXTERNAL_RTC } else if (0==strcmp(word,"date")) { word = strtok(NULL,delimiter); if (!word) { printf("current date: 20%02u-%02u-%02u\n", rtc_ds1307_read_year(), rtc_ds1307_read_month(), rtc_ds1307_read_date()); } else if (strlen(word)!=10 || word[0]!='2' || word[1]!='0' || word[2]<'0' || word[2]>'9' || word[3]<'0' || word[3]>'9' || word[5]<'0' || word[5]>'1' || word[6]<'0' || word[6]>'9' || word[8]<'0' || word[8]>'3' || word[9]<'0' || word[9]>'9') { goto error; } else { if (!rtc_ds1307_write_year((word[2]-'0')*10+(word[3]-'0')*1)) { printf("setting year failed\n"); } else if (!rtc_ds1307_write_month((word[5]-'0')*10+(word[6]-'0')*1)) { printf("setting month failed\n"); } else if (!rtc_ds1307_write_date((word[8]-'0')*10+(word[9]-'0')*1)) { printf("setting day failed\n"); } else { printf("date set\n"); } } #endif } else { goto error; } return; // command successfully processed error: printf("command not recognized. enter help to list commands\n"); } /** program entry point * this is the firmware function started by the micro-controller */ int main(void) { rcc_clock_setup_in_hse_8mhz_out_72mhz(); // use 8 MHz high speed external clock to generate 72 MHz internal clock // setup LED rcc_periph_clock_enable(LED_RCC); // enable clock for LED gpio_set_mode(LED_PORT, GPIO_MODE_OUTPUT_2_MHZ, GPIO_CNF_OUTPUT_PUSHPULL, LED_PIN); // set LED pin to 'output push-pull' led_off(); // switch off LED per default // setup USART and USB for user communication usart_setup(); // setup USART (for printing) cdcacm_setup(); // setup USB CDC ACM (for printing) setbuf(stdout, NULL); // set standard out buffer to NULL to immediately print setbuf(stderr, NULL); // set standard error buffer to NULL to immediately print // minimal setup ready printf("welcome to the CuVoodoo LED clock\n"); // print welcome message // setup button #if defined(BUTTON_RCC) && defined(BUTTON_PORT) && defined(BUTTON_PIN) && defined(BUTTON_EXTI) && defined(BUTTON_IRQ) rcc_periph_clock_enable(BUTTON_RCC); // enable clock for button gpio_set_mode(BUTTON_PORT, GPIO_MODE_INPUT, GPIO_CNF_INPUT_PULL_UPDOWN, BUTTON_PIN); // set button pin to input gpio_clear(BUTTON_PORT, BUTTON_PIN); // pull down to be able to detect button push (go high) rcc_periph_clock_enable(RCC_AFIO); // enable alternate function clock for external interrupt exti_select_source(BUTTON_EXTI, BUTTON_PORT); // mask external interrupt of this pin only for this port exti_set_trigger(BUTTON_EXTI, EXTI_TRIGGER_RISING); // trigger when button is pressed exti_enable_request(BUTTON_EXTI); // enable external interrupt nvic_enable_irq(BUTTON_IRQ); // enable interrupt #endif // setup RTC #if defined(EXTERNAL_RTC) && EXTERNAL_RTC printf("setup external RTC: "); rtc_ds1307_setup(); // setup external RTC module #else printf("setup internal RTC: "); rtc_auto_awake(RCC_LSE, 32768/ticks_second-1); // ensure internal RTC is on, uses the 32.678 kHz LSE, and the prescale is set to our tick speed, else update backup registers accordingly (power off the micro-controller for the change to take effect) rtc_interrupt_enable(RTC_SEC); // enable RTC interrupt on "seconds" nvic_enable_irq(NVIC_RTC_IRQ); // allow the RTC to interrupt #endif printf("OK\n"); // setup DCF77 printf("setup DCF77 receiver: "); rtc_dcf77_setup(); // setup DCF77 module printf("OK\n"); rtc_dcf77_on(); // switch DCF77 on to get correct time printf("DCF77 receiver switched on\n"); // notify user // setup WS2812B LEDs printf("setup LEDs: "); for (uint16_t i=0; i0) { // there is a command to process command[command_i] = 0; // end string command_i = 0; // prepare for next command process_command(command); // process user command } } else { // user command input command[command_i] = c; // save command input if (command_i=ticks_midday*2) { // one day passed #if defined(EXTERNAL_RTC) && EXTERNAL_RTC rtc_ds1307_ticks = rtc_ds1307_ticks%ticks_midday; // reset time counter #else rtc_set_counter_val(rtc_get_counter_val()%ticks_midday); // reset time counter #endif } clock_set_time(ticks_time); // set time } while (photoresistor_flag) { // new photo-resistor value has been measured photoresistor_flag = false; // reset flag action = true; // action has been performed float photoresistor_voltage = photoresistor_value*1.2/ref_value; // calculate voltage from value float new_clock_brightness = 0; // to calculate new brightness if (photoresistor_voltagePHOTORESISTOR_MIN) { // low ambient luminosity new_clock_brightness = BRIGHTNESS_MIN; // set low brightness } else { // intermediate ambient luminosity new_clock_brightness = BRIGHTNESS_MIN+(BRIGHTNESS_MAX-BRIGHTNESS_MIN)*(1-(photoresistor_voltage-PHOTORESISTOR_MAX)/(PHOTORESISTOR_MIN-PHOTORESISTOR_MAX)); // set variable brightness } clock_brightness = clock_brightness*(1-BRIGHTNESS_FACTOR)+new_clock_brightness*BRIGHTNESS_FACTOR; // calculate new brightness based on factor //printf("photo-resistor voltage: %f, clock brightness: %f\n", photoresistor_voltage, clock_brightness); } if (action) { // go to sleep if nothing had to be done, else recheck for activity action = false; } else { __WFI(); // go to sleep } } return 0; } #if defined(BUTTON_ISR) && defined(BUTTON_EXTI) /** interrupt service routine called when button is pressed */ void BUTTON_ISR(void) { exti_reset_request(BUTTON_EXTI); // reset interrupt button_flag = true; // perform button action } #endif /** interrupt service routine called when ADC conversion completed */ void adc1_2_isr(void) { photoresistor_value = adc_read_regular(ADC1); // read measured photo-resistor value (clears interrupt flag) photoresistor_flag = true; // notify new ambient luminosity has been measured } #if defined(EXTERNAL_RTC) && EXTERNAL_RTC #else /** @brief interrupt service routine called when tick passed on RTC */ void rtc_isr(void) { rtc_clear_flag(RTC_SEC); // clear flag rtc_internal_tick_flag = true; // notify to show new time } #endif