cascoda_btn_ext.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2023, Cascoda Ltd.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */
/*
 * Extended button/input/output Functions for Cascoda UI
*/
 
#ifndef CASCODA_BTN_EXT_H
#define CASCODA_BTN_EXT_H
 
#include "cascoda_btn.h"
 
/* Number of extended I/Os supported */
#define NUM_LEDBTN_EXT 8
 
/* functions */
 
ca_error Btn_RegisterOutputExt(uint8_t ledBtn);
 
ca_error Btn_RegisterButtonInputExt(uint8_t ledBtn);
 
ca_error Btn_RegisterGeneralInputExt(uint8_t ledBtn);
 
ca_error Btn_DeRegisterExt(uint8_t ledBtn);
 
ca_error Btn_CheckOutputExt(uint8_t ledBtn);
 
ca_error Btn_CheckInputOrButtonExt(uint8_t ledBtn);
 
bool Btn_HasButtonExt(void);
 
ca_error Btn_SetButtonShortPressCallbackExt(uint8_t      ledBtn,
                                            btn_callback callback,
                                            void*        context,
                                            uint8_t      shortPressMode);
 
ca_error Btn_SetButtonLongPressCallbackExt(uint8_t      ledBtn,
                                           btn_callback callback,
                                           void*        context,
                                           uint32_t     timeThreshold);
 
ca_error Btn_SetButtonHoldCallbackExt(uint8_t ledBtn, btn_callback callback, void* context, uint32_t TimeInterval);
 
ca_error Btn_PollButtonsExt(uint8_t port);
 
bool Btn_CanSleepExt(void);
 
#endif // CASCODA_BTN_EXT_H