Button.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2023 CrossControl AB
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; with
 * version 2.1 of the License.
 */
/*
 *  File description:
 *  Get status of the buttons on the side of the display and control their backlight.
 *
 *  Use the function GetButton() to get a handle to pass on to the other functions.
 *  Use the method Button_release(BUTTONHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include button_example.cpp
 *
 ************************************************/
 
#ifndef CC_BUTTON_H_
#define CC_BUTTON_H_
 
#include "CCAuxErrors.h"
#include "CCPlatform.h"
#include "CCAuxTypes.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef enum
{
    BTN_Button0            = 0x1,
    BTN_Button1            = 0x2,
    BTN_Button2            = 0x4,
    BTN_Button3            = 0x8,
    BTN_Button4            = 0x10,
    BTN_Button5            = 0x20,
    BTN_Button6            = 0x40,
    BTN_Button7            = 0x80,
    BTN_Button8            = 0x100,
    BTN_Button9            = 0x200,
    BTN_Button10           = 0x400,
    BTN_Button11           = 0x800,
    BTN_Button12           = 0x1000,
    BTN_Button13           = 0x2000,
    BTN_Button14           = 0x4000,
    BTN_Button15           = 0x8000,
    BTN_Button0_LONGPRESS  = 0x10000,
    BTN_Button1_LONGPRESS  = 0x20000,
    BTN_Button2_LONGPRESS  = 0x40000,
    BTN_Button3_LONGPRESS  = 0x80000,
    BTN_Button4_LONGPRESS  = 0x100000,
    BTN_Button5_LONGPRESS  = 0x200000,
    BTN_Button6_LONGPRESS  = 0x400000,
    BTN_Button7_LONGPRESS  = 0x800000,
    BTN_Button8_LONGPRESS  = 0x1000000,
    BTN_Button9_LONGPRESS  = 0x2000000,
    BTN_Button10_LONGPRESS = 0x4000000,
    BTN_Button11_LONGPRESS = 0x8000000,
    BTN_Button12_LONGPRESS = 0x10000000,
    BTN_Button13_LONGPRESS = 0x20000000,
    BTN_Button14_LONGPRESS = 0x40000000,
    BTN_Button15_LONGPRESS = 0x80000000
} ButtonList;
 
typedef void *BUTTONHANDLE;
 
EXTERN_C
CCAUXDLL_API
BUTTONHANDLE
CCAUXDLL_CALLING_CONV
GetButton(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV Button_release(BUTTONHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_getButtonDownStatus(BUTTONHANDLE, uint16_t *buttons);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_getBacklightPattern(BUTTONHANDLE, uint16_t *ledActiveBitmask, uint16_t *onTime,
                                                      uint16_t *offTime, uint8_t *brightness);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_setBacklightPattern(BUTTONHANDLE, uint16_t ledActiveBitmask, uint16_t onTime,
                                                      uint16_t offTime, uint8_t brightness);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_getBootBacklightPattern(BUTTONHANDLE, uint16_t *ledActiveBitmask, uint16_t *onTime,
                                                          uint16_t *offTime, uint8_t *brightness);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_setBootBacklightPattern(BUTTONHANDLE, uint16_t ledActiveBitmask, uint16_t onTime,
                                                          uint16_t offTime, uint8_t brightness);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_getStartupButtons(BUTTONHANDLE, uint32_t *buttons);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_setStartupButtons(BUTTONHANDLE, uint32_t buttons);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_getWakeupButtons(BUTTONHANDLE, uint32_t *buttons);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_setWakeupButtons(BUTTONHANDLE, uint32_t buttons);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_getSuspendButtons(BUTTONHANDLE, uint32_t *buttons);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_setSuspendButtons(BUTTONHANDLE, uint32_t buttons);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_getShutdownButtons(BUTTONHANDLE, uint32_t *buttons);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_setShutdownButtons(BUTTONHANDLE, uint32_t buttons);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_getLongPressTime(BUTTONHANDLE, uint16_t *time);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV Button_setLongPressTime(BUTTONHANDLE, uint16_t time);
 
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_BUTTON_H_ */