iot-firmware/lib/ITEADLIB_Arduino_Nextion-ma.../NexGauge.h

128 lines
3.0 KiB
C
Raw Permalink Normal View History

2023-09-30 08:42:44 +00:00
/**
* @file NexGauge.h
*
* The definition of class NexGauge.
*
* @author Wu Pengfei (email:<pengfei.wu@itead.cc>)
* @date 2015/8/13
*
* @copyright
* Copyright (C) 2014-2015 ITEAD Intelligent Systems Co., Ltd. \n
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*/
#ifndef __NEXGAUGE_H__
#define __NEXGAUGE_H__
#include "NexTouch.h"
#include "NexHardware.h"
/**
* @addtogroup Component
* @{
*/
/**
* NexGauge component.
*/
class NexGauge: public NexObject
{
public: /* methods */
/**
* @copydoc NexObject::NexObject(uint8_t pid, uint8_t cid, const char *name);
*/
NexGauge(uint8_t pid, uint8_t cid, const char *name);
/**
* Get the value of gauge.
*
* @param number - an output parameter to save gauge's value.
*
* @retval true - success.
* @retval false - failed.
*/
bool getValue(uint32_t *number);
/**
* Set the value of gauge.
*
* @param number - the value of gauge.
*
* @retval true - success.
* @retval false - failed.
*/
bool setValue(uint32_t number);
/**
* Get bco attribute of component
*
* @param number - buffer storing data retur
* @return the length of the data
*/
uint32_t Get_background_color_bco(uint32_t *number);
/**
* Set bco attribute of component
*
* @param number - To set up the data
* @return true if success, false for failure
*/
bool Set_background_color_bco(uint32_t number);
/**
* Get pco attribute of component
*
* @param number - buffer storing data retur
* @return the length of the data
*/
uint32_t Get_font_color_pco(uint32_t *number);
/**
* Set pco attribute of component
*
* @param number - To set up the data
* @return true if success, false for failure
*/
bool Set_font_color_pco(uint32_t number);
/**
* Get wid attribute of component
*
* @param number - buffer storing data retur
* @return the length of the data
*/
uint32_t Get_pointer_thickness_wid(uint32_t *number);
/**
* Set wid attribute of component
*
* @param number - To set up the data
* @return true if success, false for failure
*/
bool Set_pointer_thickness_wid(uint32_t number);
/**
* Get picc attribute of component
*
* @param number - buffer storing data retur
* @return the length of the data
*/
uint32_t Get_background_cropi_picc(uint32_t *number);
/**
* Set picc attribute of component
*
* @param number - To set up the data
* @return true if success, false for failure
*/
bool Set_background_crop_picc(uint32_t number);
};
/**
* @}
*/
#endif /* #ifndef __NEXGAUGE_H__ */