sensor-watch/movement/watch_faces/complication/flashlight_face.h
Alex Utter 7802994854
Fix missing documentation for many clock faces:
* Move from .c to .h as needed for consistency.
* When missing from both, copy from pull request or wiki.
* When missing entirely, infer functionality from source code.
2023-11-27 23:06:19 -05:00

60 lines
2.1 KiB
C

/*
* MIT License
*
* Copyright (c) 2023 Joey Castillo
*
* 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 THE
* AUTHORS OR COPYRIGHT HOLDERS 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.
*/
#ifndef FLASHLIGHT_FACE_H_
#define FLASHLIGHT_FACE_H_
/*
* FLASHLIGHT face
*
* A flashlight for use with the Flashlight sensor board.
*
* When the watch face appears, the display will show "FL" in the top two positions.
* Pressing the Light button will toggle the flashlight on and off.
*
*/
#include "movement.h"
typedef struct {
// Anything you need to keep track of, put it here!
uint8_t unused;
} flashlight_state_t;
void flashlight_face_setup(movement_settings_t *settings, uint8_t watch_face_index, void ** context_ptr);
void flashlight_face_activate(movement_settings_t *settings, void *context);
bool flashlight_face_loop(movement_event_t event, movement_settings_t *settings, void *context);
void flashlight_face_resign(movement_settings_t *settings, void *context);
#define flashlight_face ((const watch_face_t){ \
flashlight_face_setup, \
flashlight_face_activate, \
flashlight_face_loop, \
flashlight_face_resign, \
NULL, \
})
#endif // FLASHLIGHT_FACE_H_