GM6000 Digital Heater Controller Branch: main
SDX-1330
Api.h
Go to the documentation of this file.
1#ifndef Driver_PicoDisplay_STM32_API_h
2#define Driver_PicoDisplay_STM32_API_h
3/*-----------------------------------------------------------------------------
4* This file is part of the Colony.Core Project. The Colony.Core Project is an
5* open source project with a BSD type of licensing agreement. See the license
6* agreement (license.txt) in the top/ directory or on the Internet at
7* http://integerfox.com/colony.core/license.txt
8*
9* Copyright (c) 2014-2022 John T. Taylor
10*
11* Redistributions of the source code must retain the above copyright notice.
12*----------------------------------------------------------------------------*/
13/** @file
14
15 This file defines the interface for initializing the concrete implementation
16 of the PicoDisplay driver using the actual hardware
17
18 */
19
20#include "colony_config.h"
21#include "pimoroni_common.hpp"
22#include "pico_display.hpp"
23
24
25/// Pin for Button A
26#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_A_PIN
27#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_A_PIN
28#endif
29/// Port for Button A
30#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_A_PORT
31#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_A_PORT
32#endif
33
34
35/// Pin for Button B
36#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_B_PIN
37#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_B_PIN
38#endif
39/// Port for Button B
40#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_B_PORT
41#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_B_PORT
42#endif
43
44/// Pin for Button X
45#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_X_PIN
46#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_X_PIN
47#endif
48/// Port for Button X
49#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_X_PORT
50#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_X_PORT
51#endif
52
53/// Pin for Button Y
54#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_Y_PIN
55#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_Y_PIN
56#endif
57/// Port for Button Y
58#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_Y_PORT
59#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_BUTTON_Y_PORT
60#endif
61
62/// RGB LED: The Timer for the RED PWM signal
63#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_RGB_RED_TIMER
64#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_RGB_RED_TIMER
65#endif
66/// RGB LED: The Timer.Channel for the RED PWM signal
67#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_RGB_RED_CHANNEL
68#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_RGB_RED_CHANNEL
69#endif
70
71/// RGB LED: The Timer for the GREEN PWM signal
72#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_RGB_GREEN_TIMER
73#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_RGB_GREEN_TIMER
74#endif
75/// RGB LED: The Timer.Channel for the GREEN PWM signal
76#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_RGB_GREEN_CHANNEL
77#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_RGB_GREEN_CHANNEL
78#endif
79
80/// RGB LED: The Timer for the BLUE PWM signal
81#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_RGB_BLUE_TIMER
82#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_RGB_BLUE_TIMER
83#endif
84/// RGB LED: The Timer.Channel for the BLUE PWM signal
85#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_RGB_BLUE_CHANNEL
86#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_RGB_BLUE_CHANNEL
87#endif
88
89/// The default screen orientation
90#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_LCD_ROTATION
91#define OPTION_DRIVER_PICO_DISPLAY_STM32_LCD_ROTATION pimoroni::ROTATE_0
92#endif
93
94/// The default SPI bus
95#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_SPI_BUS
96#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_SPI_BUS
97#endif
98
99/// The default SPI pins - Pin
100#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_SPI_CS_PIN
101#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_SPI_CS_PIN
102#endif
103/// The default SPI pins - Port
104#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_SPI_CS_PORT
105#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_SPI_CS_PORT
106#endif
107
108/// The default SPI pins (Data/Command pin for the LCD controller) - Pin
109#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_SPI_DC_PIN
110#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_SPI_DC_PIN
111#endif
112/// The default SPI pins (Data/Command pin for the LCD controller) - Port
113#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_SPI_DC_PORT
114#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_SPI_DC_PORT
115#endif
116
117/// The default PWM signal to the backlight - Timer
118#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_BACKLIGHT_PWM_TIMER
119#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_BACKLIGHT_PWM_TIMER
120#endif
121/// The default PWM signal to the backlight - Timer.Channel
122#ifndef OPTION_DRIVER_PICO_DISPLAY_STM32_BACKLIGHT_PWM_CHANNEL
123#error Must define: OPTION_DRIVER_PICO_DISPLAY_STM32_BACKLIGHT_PWM_CHANNEL
124#endif
125
126
127///
128namespace Driver {
129///
130namespace PicoDisplay {
131///
132namespace STM32 {
133
134/** This method is used to initialize the platform specific drivers
135 */
136void initialize();
137
138
139} // End namespace(s)
140}
141}
142
143#endif // end header latch
Driver::PicoDisplay::STM32::initialize
void initialize()
This method is used to initialize the platform specific drivers.
Driver
namespace
Generated on Sat Jan 18 2025 22:23:55 for GM6000 Digital Heater Controller by doxygen 1.9.8