/*
 * MIT License
 *
 * Copyright (c) 2023 <#author_name#>
 *
 * 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 CHIRPY_DEMO_FACE_H_
#define CHIRPY_DEMO_FACE_H_

/*
 * CHIRPY DEMO FACE
 * 
 * This face demonstrates the chirpy-tx library. It is intended to help you
 * include chirpy-tx in your own watch faces that need to transmit data out
 * of the watch.
 * 
 * The face's first screen lets you select from a few built-in transmissions:
 * 
 * SCALE cycles through frequencies in fixed increments. This is intended to
 * collect and analyze audio samples from different watches. With this info
 * it may be possible to improve chirpy-tx's parameters like the frequencies
 * it uses to make the method more robust.
 * 
 * SHORT is a small transmission that contains data taked from the activity_face.
 * 
 * LONG is a longer transmission that contains the first two strophes of a
 * famous sea shanty.
 * 
 * Select the transmission you want with ALARM, the press LONG ALARM to chirp.
 * 
 * To record and decode a chirpy transmission on your computer, you can use the web app here:
 * https://jealousmarkup.xyz/off/chirpy/rx/
 */

#include "movement.h"

void chirpy_demo_face_setup(uint8_t watch_face_index, void ** context_ptr);
void chirpy_demo_face_activate(void *context);
bool chirpy_demo_face_loop(movement_event_t event, void *context);
void chirpy_demo_face_resign(void *context);

#define chirpy_demo_face ((const watch_face_t){ \
    chirpy_demo_face_setup, \
    chirpy_demo_face_activate, \
    chirpy_demo_face_loop, \
    chirpy_demo_face_resign, \
    NULL, \
})

#endif // CHIRPY_DEMO_FACE_H_

