# HG changeset patch # User Michiel Broek # Date 1540811797 -3600 # Node ID 45647136ec95012b5acd5e8d6491cd88892fc18f # Parent bc7c05011d691154d43284222fdfb0c7a0293a15 Updates for doxygen diff -r bc7c05011d69 -r 45647136ec95 components/PID/PID_v1.h --- a/components/PID/PID_v1.h Mon Oct 29 11:32:03 2018 +0100 +++ b/components/PID/PID_v1.h Mon Oct 29 12:16:37 2018 +0100 @@ -46,7 +46,7 @@ * @param[in] Ki The Intergral value. * @param[in] Kd The Derivate value. * @param[in] POn 0 - PID on Measurement, 1 - PID on Error. - * @param[in] ControllerDirection Direct or Reverse action. + * @param[in] Direction Direct or Reverse action. */ void PID(double* Input, double* Output, double* Setpoint, double Kp, double Ki, double Kd, PID_PON POn, PID_DIRECTION Direction); diff -r bc7c05011d69 -r 45647136ec95 components/esp32-owb/include/owb.h --- a/components/esp32-owb/include/owb.h Mon Oct 29 11:32:03 2018 +0100 +++ b/components/esp32-owb/include/owb.h Mon Oct 29 12:16:37 2018 +0100 @@ -46,11 +46,11 @@ // ROM commands -#define OWB_ROM_SEARCH 0xF0 -#define OWB_ROM_READ 0x33 -#define OWB_ROM_MATCH 0x55 -#define OWB_ROM_SKIP 0xCC -#define OWB_ROM_SEARCH_ALARM 0xEC +#define OWB_ROM_SEARCH 0xF0 ///< Command ROM search +#define OWB_ROM_READ 0x33 ///< ROM read +#define OWB_ROM_MATCH 0x55 ///< ROM address match +#define OWB_ROM_SKIP 0xCC ///< Skip device +#define OWB_ROM_SEARCH_ALARM 0xEC ///< Search device with alarm set #define OWB_ROM_CODE_STRING_LENGTH (17) ///< Typical length of OneWire bus ROM ID as ASCII hex string, including null terminator @@ -100,15 +100,18 @@ int last_device_flag; } OneWireBus_SearchState; +/** + * @brief Status codes + */ typedef enum { - OWB_STATUS_OK, - OWB_STATUS_NOT_INITIALIZED, - OWB_STATUS_PARAMETER_NULL, - OWB_STATUS_DEVICE_NOT_RESPONDING, - OWB_STATUS_CRC_FAILED, - OWB_STATUS_TOO_MANY_BITS, - OWB_STATUS_HW_ERROR + OWB_STATUS_OK, ///< Ok + OWB_STATUS_NOT_INITIALIZED, ///< Init error + OWB_STATUS_PARAMETER_NULL, ///< NULL parameter + OWB_STATUS_DEVICE_NOT_RESPONDING, ///< Device does not respond + OWB_STATUS_CRC_FAILED, ///< CRC error + OWB_STATUS_TOO_MANY_BITS, ///< Too many bits + OWB_STATUS_HW_ERROR ///< Hardware error } owb_status; /** NOTE: Driver assumes that (*init) was called prior to any other methods */ @@ -133,6 +136,8 @@ /** * @brief call to release resources after completing use of the OneWireBus + * @param[in] bus Pointer to initialised bus instance. + * @return status */ owb_status owb_uninitialize(OneWireBus * bus); @@ -164,7 +169,7 @@ /** * @brief Reset the 1-Wire bus. * @param[in] bus Pointer to initialised bus instance. - * @param[out] is_present set to true if at least one device is present on the bus + * @param[out] a_device_present set to true if at least one device is present on the bus * @return status */ owb_status owb_reset(const OneWireBus * bus, bool* a_device_present); diff -r bc7c05011d69 -r 45647136ec95 components/esp32-owb/include/owb_gpio.h --- a/components/esp32-owb/include/owb_gpio.h Mon Oct 29 11:32:03 2018 +0100 +++ b/components/esp32-owb/include/owb_gpio.h Mon Oct 29 12:16:37 2018 +0100 @@ -33,6 +33,9 @@ extern "C" { #endif +/** + * @brief 1-wire bus connection on the gpio. + */ typedef struct { int gpio; ///< Value of the GPIO connected to the 1-Wire bus diff -r bc7c05011d69 -r 45647136ec95 components/tft/tft.c --- a/components/tft/tft.c Mon Oct 29 11:32:03 2018 +0100 +++ b/components/tft/tft.c Mon Oct 29 12:16:37 2018 +0100 @@ -45,25 +45,25 @@ extern uint8_t tft_def_small[]; // ==== Color definitions constants ============== -const color_t TFT_BLACK = { 0, 0, 0 }; -const color_t TFT_NAVY = { 0, 0, 128 }; -const color_t TFT_DARKGREEN = { 0, 128, 0 }; -const color_t TFT_DARKCYAN = { 0, 128, 128 }; -const color_t TFT_MAROON = { 128, 0, 0 }; -const color_t TFT_PURPLE = { 128, 0, 128 }; -const color_t TFT_OLIVE = { 128, 128, 0 }; -const color_t TFT_LIGHTGREY = { 192, 192, 192 }; -const color_t TFT_DARKGREY = { 128, 128, 128 }; -const color_t TFT_BLUE = { 0, 0, 255 }; -const color_t TFT_GREEN = { 0, 255, 0 }; -const color_t TFT_CYAN = { 0, 255, 255 }; -const color_t TFT_RED = { 255, 0, 0 }; -const color_t TFT_MAGENTA = { 255, 0, 255 }; -const color_t TFT_YELLOW = { 255, 255, 0 }; -const color_t TFT_WHITE = { 255, 255, 255 }; -const color_t TFT_ORANGE = { 255, 164, 0 }; -const color_t TFT_GREENYELLOW = { 172, 255, 44 }; -const color_t TFT_PINK = { 255, 192, 202 }; +const color_t TFT_BLACK = { 0, 0, 0 }; ///< Black +const color_t TFT_NAVY = { 0, 0, 128 }; ///< Navy blue +const color_t TFT_DARKGREEN = { 0, 128, 0 }; ///< Dark green +const color_t TFT_DARKCYAN = { 0, 128, 128 }; ///< Dark cyan +const color_t TFT_MAROON = { 128, 0, 0 }; ///< Maroon red +const color_t TFT_PURPLE = { 128, 0, 128 }; ///< Purple +const color_t TFT_OLIVE = { 128, 128, 0 }; ///< Olive +const color_t TFT_LIGHTGREY = { 192, 192, 192 }; ///< Light gray +const color_t TFT_DARKGREY = { 128, 128, 128 }; ///< Dark gray +const color_t TFT_BLUE = { 0, 0, 255 }; ///< Blue +const color_t TFT_GREEN = { 0, 255, 0 }; ///< Green +const color_t TFT_CYAN = { 0, 255, 255 }; ///< Cyan +const color_t TFT_RED = { 255, 0, 0 }; ///< Red +const color_t TFT_MAGENTA = { 255, 0, 255 }; ///< Magenta +const color_t TFT_YELLOW = { 255, 255, 0 }; ///< Yellow +const color_t TFT_WHITE = { 255, 255, 255 }; ///< White +const color_t TFT_ORANGE = { 255, 164, 0 }; ///< Orange +const color_t TFT_GREENYELLOW = { 172, 255, 44 }; ///< Green-yellow +const color_t TFT_PINK = { 255, 192, 202 }; ///< Pink // =============================================== // ============================================================== diff -r bc7c05011d69 -r 45647136ec95 components/tft/tft.h --- a/components/tft/tft.h Mon Oct 29 11:32:03 2018 +0100 +++ b/components/tft/tft.h Mon Oct 29 12:16:37 2018 +0100 @@ -12,6 +12,9 @@ #include #include "tftspi.h" +/** + * @brief Window coordinates + */ typedef struct { uint16_t x1; uint16_t y1; @@ -19,6 +22,9 @@ uint16_t y2; } dispWin_t; +/** + * @brief Font description. + */ typedef struct { uint8_t *font; uint8_t x_size; @@ -56,29 +62,14 @@ // ========================================================================================= -// Buffer is created during jpeg decode for sending data -// Total size of the buffer is 2 * (JPG_IMAGE_LINE_BUF_SIZE * 3) -// The size must be multiple of 256 bytes !! -#define JPG_IMAGE_LINE_BUF_SIZE 512 - -// --- Constants for ellipse function --- -#define TFT_ELLIPSE_UPPER_RIGHT 0x01 -#define TFT_ELLIPSE_UPPER_LEFT 0x02 -#define TFT_ELLIPSE_LOWER_LEFT 0x04 -#define TFT_ELLIPSE_LOWER_RIGHT 0x08 - -// Constants for Arc function -// number representing the maximum angle (e.g. if 100, then if you pass in start=0 and end=50, you get a half circle) -// this can be changed with setArcParams function at runtime -#define DEFAULT_ARC_ANGLE_MAX 360 -// rotational offset in degrees defining position of value 0 (-90 will put it at the top of circle) -// this can be changed with setAngleOffset function at runtime +/** + * @brief rotational offset in degrees defining position of value 0 (-90 will put it at the top of circle) + * this can be changed with setAngleOffset function at runtime + */ #define DEFAULT_ANGLE_OFFSET -90 #define PI 3.14159265359 -#define MIN_POLIGON_SIDES 3 -#define MAX_POLIGON_SIDES 60 // === Color names constants === extern const color_t TFT_BLACK; @@ -101,17 +92,14 @@ extern const color_t TFT_GREENYELLOW; extern const color_t TFT_PINK; -// === Color invert constants === -#define INVERT_ON 1 -#define INVERT_OFF 0 // === Special coordinates constants === -#define CENTER -9003 -#define RIGHT -9004 -#define BOTTOM -9004 +#define CENTER -9003 ///< Center X or Y +#define RIGHT -9004 ///< Right X +#define BOTTOM -9004 ///< Bottom Y -#define LASTX 7000 -#define LASTY 8000 +#define LASTX 7000 ///< At last X position +#define LASTY 8000 ///< At last Y position // === Embedded fonts constants === #define DEFAULT_FONT 0 ///< 12 points 95 characters DejaVu font.