1
0
mirror of https://github.com/esphome/esphome.git synced 2025-03-15 23:28:13 +00:00
esphome/esphome/core/esphal.h

119 lines
3.3 KiB
C
Raw Normal View History

🏗 Merge C++ into python codebase (#504) ## Description: Move esphome-core codebase into esphome (and a bunch of other refactors). See https://github.com/esphome/feature-requests/issues/97 Yes this is a shit ton of work and no there's no way to automate it :( But it will be worth it 👍 Progress: - Core support (file copy etc): 80% - Base Abstractions (light, switch): ~50% - Integrations: ~10% - Working? Yes, (but only with ported components). Other refactors: - Moves all codegen related stuff into a single class: `esphome.codegen` (imported as `cg`) - Rework coroutine syntax - Move from `component/platform.py` to `domain/component.py` structure as with HA - Move all defaults out of C++ and into config validation. - Remove `make_...` helpers from Application class. Reason: Merge conflicts with every single new integration. - Pointer Variables are stored globally instead of locally in setup(). Reason: stack size limit. Future work: - Rework const.py - Move all `CONF_...` into a conf class (usage `conf.UPDATE_INTERVAL` vs `CONF_UPDATE_INTERVAL`). Reason: Less convoluted import block - Enable loading from `custom_components` folder. **Related issue (if applicable):** https://github.com/esphome/feature-requests/issues/97 **Pull request in [esphome-docs](https://github.com/esphome/esphome-docs) with documentation (if applicable):** esphome/esphome-docs#<esphome-docs PR number goes here> ## Checklist: - [ ] The code change is tested and works locally. - [ ] Tests have been added to verify that the new code works (under `tests/` folder). If user exposed functionality or configuration variables are added/changed: - [ ] Documentation added/updated in [esphomedocs](https://github.com/OttoWinter/esphomedocs).
2019-04-17 12:06:00 +02:00
#pragma once
#include "Arduino.h"
#ifdef ARDUINO_ARCH_ESP32
#include <esp32-hal.h>
#endif
// Fix some arduino defs
#ifdef round
#undef round
#endif
#ifdef bool
#undef bool
#endif
#ifdef true
#undef true
#endif
#ifdef false
#undef false
#endif
#ifdef min
#undef min
#endif
#ifdef max
#undef max
#endif
#ifdef abs
#undef abs
#endif
namespace esphome {
#define LOG_PIN(prefix, pin) \
if ((pin) != nullptr) { \
ESP_LOGCONFIG(TAG, prefix LOG_PIN_PATTERN, LOG_PIN_ARGS(pin)); \
}
#define LOG_PIN_PATTERN "GPIO%u (Mode: %s%s)"
#define LOG_PIN_ARGS(pin) (pin)->get_pin(), (pin)->get_pin_mode_name(), ((pin)->is_inverted() ? ", INVERTED" : "")
/// Copy of GPIOPin that is safe to use from ISRs (with no virtual functions)
class ISRInternalGPIOPin {
public:
ISRInternalGPIOPin(uint8_t pin,
#ifdef ARDUINO_ARCH_ESP32
volatile uint32_t *gpio_clear, volatile uint32_t *gpio_set,
#endif
volatile uint32_t *gpio_read, uint32_t gpio_mask, bool inverted);
bool digital_read();
void digital_write(bool value);
void clear_interrupt();
protected:
const uint8_t pin_;
const bool inverted_;
volatile uint32_t *const gpio_read_;
const uint32_t gpio_mask_;
#ifdef ARDUINO_ARCH_ESP32
volatile uint32_t *const gpio_clear_;
volatile uint32_t *const gpio_set_;
#endif
};
/** A high-level abstraction class that can expose a pin together with useful options like pinMode.
*
* Set the parameters for this at construction time and use setup() to apply them. The inverted parameter will
* automatically invert the input/output for you.
*
* Use read_value() and write_value() to use digitalRead() and digitalWrite(), respectively.
*/
class GPIOPin {
public:
/** Construct the GPIOPin instance.
*
* @param pin The GPIO pin number of this instance.
* @param mode The Arduino pinMode that this pin should be put into at setup().
* @param inverted Whether all digitalRead/digitalWrite calls should be inverted.
*/
GPIOPin(uint8_t pin, uint8_t mode, bool inverted = false);
/// Setup the pin mode.
virtual void setup();
/// Read the binary value from this pin using digitalRead (and inverts automatically).
virtual bool digital_read();
/// Write the binary value to this pin using digitalWrite (and inverts automatically).
virtual void digital_write(bool value);
/// Set the pin mode
virtual void pin_mode(uint8_t mode);
/// Get the GPIO pin number.
uint8_t get_pin() const;
const char *get_pin_mode_name() const;
/// Get the pinMode of this pin.
uint8_t get_mode() const;
/// Return whether this pin shall be treated as inverted. (for example active-low)
bool is_inverted() const;
template<typename T> void attach_interrupt(void (*func)(T *), T *arg, int mode) const;
ISRInternalGPIOPin *to_isr() const;
protected:
void attach_interrupt_(void (*func)(void *), void *arg, int mode) const;
const uint8_t pin_;
const uint8_t mode_;
const bool inverted_;
#ifdef ARDUINO_ARCH_ESP32
volatile uint32_t *const gpio_set_;
volatile uint32_t *const gpio_clear_;
#endif
volatile uint32_t *const gpio_read_;
const uint32_t gpio_mask_;
};
template<typename T> void GPIOPin::attach_interrupt(void (*func)(T *), T *arg, int mode) const {
this->attach_interrupt_(reinterpret_cast<void (*)(void *)>(func), arg, mode);
}
} // namespace esphome