]> git.earman.xyz Git - sensor-watch.git/commitdiff
make watch abstraction global, add methods and documentation
authorJoey Castillo <jose.castillo@gmail.com>
Fri, 21 May 2021 21:56:30 +0000 (14:56 -0700)
committerJoey Castillo <jose.castillo@gmail.com>
Fri, 21 May 2021 21:56:30 +0000 (14:56 -0700)
Smol Watch Project/My Project/main.c
Smol Watch Project/My Project/mars_clock.c
Smol Watch Project/My Project/mars_clock.h
Smol Watch Project/My Project/watch-library/watch.c
Smol Watch Project/My Project/watch-library/watch.h

index 053840a28601f55505bf08469188eea4f95e1f85..53ccda95104f575431ef312980368bafaff21917 100644 (file)
@@ -3,7 +3,6 @@
 #include "watch-library/watch.h"
 #include "mars_clock.h"
 
-Watch watch;
 bool local = true;
 
 void calendar_callback(struct calendar_descriptor *const calendar) {
@@ -34,9 +33,9 @@ int main(void)
 {
        atmel_start_init();
 
-       watch_init(&watch);
+       watch_init();
 
-       watch_enable_date_time(&watch);
+       watch_enable_date_time();
        struct calendar_date_time date_time;
        date_time.date.year = 2021;
        date_time.date.month = 5;
@@ -45,29 +44,28 @@ int main(void)
        date_time.time.min = 40;
        date_time.time.sec = 0;
        watch_set_date_time(date_time);
-       update_display(&watch, date_time, local);
+       update_display(date_time, local);
        watch_enable_tick(tick_callback);
 
-       gpio_set_pin_level(RED, false);
-       gpio_set_pin_direction(RED, GPIO_DIRECTION_OUT);
-       gpio_set_pin_function(RED, GPIO_PIN_FUNCTION_OFF);
-       gpio_set_pin_level(GREEN, false);
-       gpio_set_pin_direction(GREEN, GPIO_DIRECTION_OUT);
-       gpio_set_pin_function(GREEN, GPIO_PIN_FUNCTION_OFF);
+       watch_enable_led();
 
-       watch_enable_buttons(&watch);
-       watch_register_button_callback(&watch, BTN_MODE, &mode_callback);
-       watch_register_button_callback(&watch, BTN_ALARM, &alarm_callback);
-       watch_register_button_callback(&watch, BTN_LIGHT, &light_callback);
+       watch_enable_buttons();
+       watch_register_button_callback(BTN_MODE, &mode_callback);
+       watch_register_button_callback(BTN_ALARM, &alarm_callback);
+       watch_register_button_callback(BTN_LIGHT, &light_callback);
 
-       watch_enable_display(&watch);
-       watch_display_pixel(&watch, 1, 16);
+       watch_enable_display();
+       watch_display_pixel(1, 16);
 
        while (1) {
-               sleep(4);
+               if (watch_can_enter_standby()) {
+                       sleep(4);
+               } else {
+                       sleep(2);
+               }
                struct calendar_date_time date_time;
                calendar_get_date_time(&CALENDAR_0, &date_time);
-               update_display(&watch, date_time, local);
+               update_display(date_time, local);
        }
        
        return 0;
index 53ce33625505d6e102fb6644db87880b22ec33ad..29ea53e3afcaf78da6aa7f049741dfc687f21be9 100644 (file)
@@ -67,7 +67,7 @@ void h_to_hms(struct calendar_date_time *date_time, double h) {
 }\r
 \r
 \r
-void update_display(Watch *watch, struct calendar_date_time date_time, bool local) {
+void update_display(struct calendar_date_time date_time, bool local) {
        char buf[6];
        if (local) {
                sprintf(&buf[0], "TE  %02d%02d%02d", date_time.time.hour, date_time.time.min, date_time.time.sec);
@@ -82,5 +82,5 @@ void update_display(Watch *watch, struct calendar_date_time date_time, bool loca
                h_to_hms(&mars_time, mtc);\r
                sprintf(&buf[0], "MA  %02d%02d%02d", mars_time.time.hour, mars_time.time.min, mars_time.time.sec);
        }
-       watch_display_string(watch, buf, 0);
+       watch_display_string(buf, 0);
 }
index 71b45f33924c3c42c514b11037fcea7df0d1e350..60dad9e8653a983dcad0bcd598c316d9781ff1fc 100644 (file)
@@ -11,7 +11,7 @@
 #include "hpl_calendar.h"\r
 #include "watch-library/watch.h"\r
 \r
-void update_display(Watch *watch, struct calendar_date_time date_time, bool local);\r
+void update_display(struct calendar_date_time date_time, bool local);\r
 \r
 \r
 #endif /* MARS_CLOCK_H_ */
\ No newline at end of file
index 84a57d4b093551248b548a5f46c1bae3057ba36c..a3ace739e7ea712a9b709c33d3851e38735e399b 100644 (file)
 #include <stdlib.h>\r
 #include <string.h>\r
 \r
-void watch_init(Watch *watch) {\r
-       memset(watch, 0, sizeof(*watch));\r
+Watch watch;\r
+struct io_descriptor *I2C_0_io;
+\r
+void watch_init() {\r
+       memset(&watch, 0, sizeof(watch));\r
        // use switching regulator\r
        SUPC->VREG.bit.SEL = 1;\r
        while(!SUPC->STATUS.bit.VREGRDY);\r
@@ -20,6 +23,52 @@ void watch_init(Watch *watch) {
 //     hri_pm_write_PLCFG_PLDIS_bit(PM, true);
 }\r
 \r
+bool watch_is_display_enabled() {\r
+       return watch.display_enabled;\r
+}\r
+\r
+bool watch_is_led_enabled() {\r
+       return watch.led_enabled;\r
+}\r
+\r
+\r
+bool watch_is_buzzer_enabled() {\r
+       return watch.buzzer_enabled;\r
+}\r
+\r
+\r
+bool watch_is_calendar_enabled() {\r
+       return watch.calendar_enabled;\r
+}\r
+\r
+\r
+bool watch_is_adc_enabled() {\r
+       return watch.adc_enabled;\r
+}\r
+\r
+\r
+bool watch_is_i2c_enabled() {\r
+       return watch.i2c_enabled;\r
+}\r
+\r
+\r
+bool watch_is_spi_enabled() {\r
+       return watch.spi_enabled;\r
+}\r
+\r
+\r
+bool watch_is_eic_enabled() {\r
+       return watch.eic_enabled;\r
+}\r
+\r
+bool watch_can_enter_standby() {\r
+       return !watch.led_enabled && !watch.buzzer_enabled && (watch.eic_enabled || watch.calendar_enabled);\r
+}\r
+\r
+bool watch_can_enter_backup() {\r
+       return watch.calendar_enabled;\r
+}\r
+\r
 const uint8_t Character_Set[] =\r
 {\r
     0b00000000, //  \r
@@ -119,39 +168,39 @@ const uint8_t Character_Set[] =
     0b00000001, // ~\r
 };\r
 \r
-void watch_enable_display(Watch *watch) {\r
-       if (watch->display_enabled) return;\r
+void watch_enable_display() {\r
+       if (watch.display_enabled) return;\r
 \r
        static const uint64_t segmap[] = {\r
-               0x4e4f0e8e8f8d4d0d, // Position 8\r
-               0xc8c4c4c8b4b4b0b,  // Position 9\r
-               0xc049c00a49890949, // Position 6\r
-               0xc048088886874707, // Position 7\r
-               0xc053921252139352, // Position 0\r
+               0x4e4f0e8e8f8d4d0d, // Top center position 0\r
+               0xc8c4c4c8b4b4b0b,  // Top center position 1\r
+               0xc049c00a49890949, // Top right position 0\r
+               0xc048088886874707, // Top right position 1\r
+               0xc053921252139352, // Main display position 0\r
                0xc054511415559594, // Position 1\r
                0xc057965616179716, // Position 2\r
                0xc041804000018a81, // Position 3\r
                0xc043420203048382, // Position 4\r
                0xc045440506468584, // Position 5\r
        };\r
-       watch->num_chars = 10;\r
-       watch->segment_map = &segmap[0];\r
+       watch.num_chars = 10;\r
+       watch.segment_map = &segmap[0];\r
 \r
        SEGMENT_LCD_0_init();
        slcd_sync_enable(&SEGMENT_LCD_0);
-       watch->display_enabled = true;
+       watch.display_enabled = true;
 }\r
 \r
-void watch_display_pixel(Watch *watch, uint8_t com, uint8_t seg) {
+void watch_display_pixel(uint8_t com, uint8_t seg) {
        slcd_sync_seg_on(&SEGMENT_LCD_0, SLCD_SEGID(com, seg));
 }
 \r
-void watch_clear_pixel(Watch *watch, uint8_t com, uint8_t seg) {
+void watch_clear_pixel(uint8_t com, uint8_t seg) {
        slcd_sync_seg_off(&SEGMENT_LCD_0, SLCD_SEGID(com, seg));
 }
 \r
-void watch_display_character(Watch *watch, uint8_t character, uint8_t position) {
-       uint64_t segmap = watch->segment_map[position];\r
+void watch_display_character(uint8_t character, uint8_t position) {
+       uint64_t segmap = watch.segment_map[position];\r
        uint64_t segdata = Character_Set[character - 0x20];\r
 \r
        for (int i = 0; i < 8; i++) {\r
@@ -170,25 +219,25 @@ void watch_display_character(Watch *watch, uint8_t character, uint8_t position)
        }\r
 }
 \r
-void watch_display_string(Watch *watch, char *string, uint8_t position) {
+void watch_display_string(char *string, uint8_t position) {
        size_t i = 0;
        while(string[i] != 0) {
-               watch_display_character(watch, string[i], position + i);
+               watch_display_character(string[i], position + i);
                i++;
-               if (i >= watch->num_chars) break;
+               if (i >= watch.num_chars) break;
        }
 }
 \r
-void watch_enable_buttons(Watch *watch) {
+void watch_enable_buttons() {
        EXTERNAL_IRQ_0_init();
 }
 \r
-void watch_register_button_callback(Watch *watch, const uint32_t pin, ext_irq_cb_t callback) {
+void watch_register_button_callback(const uint32_t pin, ext_irq_cb_t callback) {
        ext_irq_register(pin, callback);
 }
 \r
-void watch_enable_led(Watch *watch) {\r
-       if (watch->led_enabled) return;\r
+void watch_enable_led() {\r
+       if (watch.led_enabled) return;\r
 \r
        PWM_0_CLOCK_init();
        PWM_0_PORT_init();
@@ -199,12 +248,12 @@ void watch_enable_led(Watch *watch) {
        TC3->COUNT8.WAVE.reg = TC_WAVE_WAVEGEN_NPWM;\r
        TC3->COUNT8.CTRLA.reg |= TC_CTRLA_ENABLE;\r
 \r
-       watch->led_enabled = true;\r
+       watch.led_enabled = true;\r
        watch_set_led_off();\r
 }\r
 \r
-void watch_disable_led(Watch *watch) {\r
-       if (!watch->led_enabled) return;\r
+void watch_disable_led() {\r
+       if (!watch.led_enabled) return;\r
 \r
        gpio_set_pin_function(RED, GPIO_PIN_FUNCTION_OFF);\r
        gpio_set_pin_function(GREEN, GPIO_PIN_FUNCTION_OFF);\r
@@ -212,7 +261,7 @@ void watch_disable_led(Watch *watch) {
        hri_tc_clear_CTRLA_ENABLE_bit(TC3);
        hri_mclk_clear_APBCMASK_TC3_bit(MCLK);
 \r
-       watch->led_enabled = false;\r
+       watch.led_enabled = false;\r
 }\r
 \r
 void watch_set_led_color(uint8_t red, uint8_t green) {\r
@@ -221,23 +270,31 @@ void watch_set_led_color(uint8_t red, uint8_t green) {
 }\r
 \r
 void watch_set_led_red() {\r
-       watch_set_led_color(255, 0);\r
+       watch_set_led_color(64, 0);\r
 }\r
 \r
 void watch_set_led_green() {\r
-       watch_set_led_color(0, 255);\r
+       watch_set_led_color(0, 64);\r
 }\r
 \r
 void watch_set_led_off() {\r
        watch_set_led_color(0, 0);\r
 }\r
 \r
-void watch_enable_date_time(Watch *watch) {\r
-       if (watch->calendar_enabled) return;\r
+void watch_enable_buzzer() {\r
+       PWM_1_init();\r
+}\r
+\r
+void watch_disable_buzzer() {\r
+       // TODO\r
+}\r
+\r
+void watch_enable_date_time() {\r
+       if (watch.calendar_enabled) return;\r
        CALENDAR_0_init();\r
        calendar_enable(&CALENDAR_0);\r
        \r
-       watch->calendar_enabled = true;\r
+       watch.calendar_enabled = true;\r
 }\r
 \r
 void watch_set_date_time(struct calendar_date_time date_time) {\r
@@ -261,8 +318,8 @@ void watch_enable_tick(ext_irq_cb_t callback) {
        _tamper_register_callback(&CALENDAR_0.device, &tick_callback);
 }\r
 \r
-void watch_enable_analog(Watch *watch, const uint8_t pin) {\r
-       if (!watch->adc_enabled) ADC_0_init();\r
+void watch_enable_analog(const uint8_t pin) {\r
+       if (!watch.adc_enabled) ADC_0_init();\r
 \r
        switch (pin) {\r
                case A0:\r
@@ -292,8 +349,8 @@ void watch_enable_digital_output(const uint8_t pin) {
 \r
 struct io_descriptor *I2C_0_io;\r
 \r
-void watch_enable_i2c(Watch *watch) {\r
-       if (watch->i2c_enabled) return;\r
+void watch_enable_i2c() {\r
+       if (watch.i2c_enabled) return;\r
        I2C_0_init();\r
        i2c_m_sync_get_io_descriptor(&I2C_0, &I2C_0_io);\r
        i2c_m_sync_enable(&I2C_0);\r
index dc48c89bf939288c9465400a7848fa3de61a759d..c183d5f694e00e26f8a239547ccc3f81ab5a5e9d 100644 (file)
@@ -26,36 +26,72 @@ typedef struct Watch {
        const uint64_t* segment_map;\r
 } Watch;\r
 \r
-void watch_init(Watch *watch);\r
+// initialize the Watch struct, set power options and global settings\r
+void watch_init();\r
 \r
-void watch_enable_display(Watch *watch);
-void watch_display_pixel(Watch *watch, uint8_t com, uint8_t seg);
-void watch_display_string(Watch *watch, char *string, uint8_t position);
+// getters for figuring out if functionality is enabled\r
+bool watch_is_display_enabled();\r
+bool watch_is_led_enabled();\r
+bool watch_is_buzzer_enabled();\r
+bool watch_is_calendar_enabled();\r
+bool watch_is_adc_enabled();\r
+bool watch_is_i2c_enabled();\r
+bool watch_is_spi_enabled();\r
+bool watch_is_eic_enabled();\r
 \r
-void watch_enable_led(Watch *watch);\r
-void watch_disable_led(Watch *watch);\r
+// the watch can standby as long as there are no PWM's active and either the RTC or the EIC is active.\r
+bool watch_can_enter_standby();\r
+\r
+// the watch can enter deep sleep as long as the RTC is enabled (so we have a wake source)\r
+bool watch_can_enter_backup();\r
+\r
+// display-oriented methods\r
+void watch_enable_display();
+void watch_display_pixel(uint8_t com, uint8_t seg);
+void watch_display_string(char *string, uint8_t position);
+\r
+// LED-oriented methods\r
+// enable the TC for PWM of the LED's, including the clock source and pin mux\r
+void watch_enable_led();\r
+// disable the TC's clock source and assign the LED pins no function. Call this before re-entering standby.\r
+void watch_disable_led();\r
+// sets the LED color to some combination of red and green.\r
 void watch_set_led_color(uint8_t red, uint8_t green);
+// sets the red LED to an indicator level of brightness (may not make the screen readable in the dark)\r
 void watch_set_led_red();\r
+// sets the green LED to an indicator level of brightness (may not make the screen readable in the dark)\r
 void watch_set_led_green();\r
+// sets both red and green LEDs to 0% intensity (but does not disable the TC).\r
 void watch_set_led_off();\r
 \r
-void watch_enable_date_time(Watch *watch);
+// buzzer\r
+void watch_enable_buzzer();\r
+void watch_disable_buzzer();\r
+\r
+// calendar, RTC and external wake functions\r
+// enable the RTC peripheral\r
+void watch_enable_date_time();
+// set the date and time
 void watch_set_date_time(struct calendar_date_time date_time);\r
+// get the date and time from the RTC\r
 void watch_get_date_time(struct calendar_date_time *date_time);\r
-\r
+// enable a one-second tick callback from the RTC.\r
 void watch_enable_tick(ext_irq_cb_t callback);\r
 \r
-void watch_enable_analog(Watch *watch, const uint8_t pin);
+// analog-related functions\r
+void watch_enable_analog(const uint8_t pin);
 
-void watch_enable_buttons(Watch *watch);
-void watch_register_button_callback(Watch *watch, const uint32_t pin, ext_irq_cb_t callback);
+// external interrupt functions (todo: rename for clarity)
+void watch_enable_buttons();
+// enable external interrupt callback for a given pin
+void watch_register_button_callback(const uint32_t pin, ext_irq_cb_t callback);
 
+// digital IO functions
 void watch_enable_digital_input(const uint8_t pin);
 void watch_enable_digital_output(const uint8_t pin);
 
-struct io_descriptor *I2C_0_io;
-
-void watch_enable_i2c(Watch *watch);
+// I2C functions
+void watch_enable_i2c();
 void watch_i2c_send(int16_t addr, uint8_t *buf, uint16_t length);
 void watch_i2c_receive(int16_t addr, uint8_t *buf, uint16_t length);\r
 \r