SoftKey.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 current status of buttons connected to SS
 *
 *  Use the function GetSoftKey() to get a handle to pass on to the other functions.
 *  Use the method SoftKey_release(SOFTKEYHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include softkey_example.cpp
 *
 ************************************************/
 
#ifndef CC_SOFTKEY_H_
#define CC_SOFTKEY_H_
 
#include "CCAuxErrors.h"
#include "CCPlatform.h"
#include "CCAuxTypes.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef void *SOFTKEYHANDLE;
 
EXTERN_C
CCAUXDLL_API
SOFTKEYHANDLE
CCAUXDLL_CALLING_CONV
GetSoftKey(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV SoftKey_release(SOFTKEYHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_getStatus(SOFTKEYHANDLE, uint16_t *value);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_setBacklightIntensity(SOFTKEYHANDLE, uint8_t key, uint8_t intensity);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_getBacklightIntensity(SOFTKEYHANDLE, uint8_t key, uint8_t *intensity);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_setMultipleBacklightIntensities(SOFTKEYHANDLE, uint8_t *keys, uint8_t *intensities,
                                                                   uint8_t array_size);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_getMultipleBacklightIntensities(SOFTKEYHANDLE, uint8_t *keys, uint8_t *intensities,
                                                                   uint8_t array_size);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_getBacklightSignal(SOFTKEYHANDLE, float64_t *frequency, uint8_t *dutyCycle);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_getBacklightOnTime(SOFTKEYHANDLE, uint8_t *onTime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_getBacklightOffTime(SOFTKEYHANDLE, uint8_t *offTime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_getBacklightIdleTime(SOFTKEYHANDLE, uint8_t *idleTime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_getBacklightNrOfPulses(SOFTKEYHANDLE, uint8_t *nrOfPulses);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_setBacklightSignal(SOFTKEYHANDLE, float64_t frequency, uint8_t dutyCycle);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_setBacklightOnTime(SOFTKEYHANDLE, uint8_t onTime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_setBacklightOffTime(SOFTKEYHANDLE, uint8_t offTime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_setBacklightIdleTime(SOFTKEYHANDLE, uint8_t idleTime);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_setBacklightNrOfPulses(SOFTKEYHANDLE, uint8_t nrOfPulses);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_setBacklightOff(SOFTKEYHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_getBacklightEnabledDuringStartup(SOFTKEYHANDLE, CCStatus *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_setBacklightEnabledDuringStartup(SOFTKEYHANDLE, CCStatus status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_getBootBacklightConfig(SOFTKEYHANDLE, uint8_t *bootIntensity,
                                                          float32_t *bootFrequency, uint8_t *bootDutyCycle,
                                                          uint8_t *postBootIntensity, float32_t *postBootFrequency,
                                                          uint8_t *postBootDutyCycle, CCStatus *postBootConfig);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV SoftKey_setBootBacklightConfig(SOFTKEYHANDLE, uint8_t bootIntensity, float32_t bootFrequency,
                                                          uint8_t bootDutyCycle, uint8_t postBootIntensity,
                                                          float32_t postBootFrequency, uint8_t postBootDutyCycle,
                                                          CCStatus postBootConfig);
 
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_SOFTKEY_H_ */