pin.h

Go to the documentation of this file.

#pragma once

 
#include "fl/stl/stdint.h"
#include "fl/stl/noexcept.h"
 
namespace fl {
 
// ============================================================================
// Pin Configuration Enums
// ============================================================================

enum class PinMode {
    Input = 0,         
    Output,            
    InputPullup,       
    InputPulldown      
};

enum class PinValue {
    Low = 0,           
    High = 1           
};

enum class AdcRange {
    Default = 0,       
    Range0_1V1,        
    Range0_1V5,        
    Range0_2V2,        
    Range0_3V3,        
    Range0_5V,         
    External           
};
 
// ============================================================================
// Function declarations (implementations in platform-specific .hpp files)
// ============================================================================
 
// These five names are spelled with parentheses, e.g. `void (pinMode)(...)`.
// A function-like macro expands wherever its name is followed by `(`, even
// after `fl::` or in a declaration, and parentheses are the only way to opt
// out. Arduino-ESP32 boards with BOARD_HAS_PIN_REMAP (Arduino Nano ESP32)
// define exactly these names as macros in io_pin_remap.h, remapping Arduino
// D-numbers to GPIO numbers. FastLED's pin numbers are always raw GPIO
// numbers, so that remap must never reach them. Every declaration, definition
// and FastLED-side call site uses the same spelling (see #4914).

void (pinMode)(int pin, PinMode mode) FL_NO_EXCEPT;

void (digitalWrite)(int pin, PinValue val) FL_NO_EXCEPT;

PinValue (digitalRead)(int pin) FL_NO_EXCEPT;

u16 (analogRead)(int pin) FL_NO_EXCEPT;

void (analogWrite)(int pin, u16 val) FL_NO_EXCEPT;

void setPwm16(int pin, u16 val) FL_NO_EXCEPT;

inline void analogWrite16(int pin, u16 val) FL_NO_EXCEPT {
    setPwm16(pin, val);
}

void setAdcRange(AdcRange range) FL_NO_EXCEPT;
 
// ============================================================================
// PWM Frequency Control
// ============================================================================

int setPwmFrequency(int pin, u32 frequency_hz) FL_NO_EXCEPT;

u32 getPwmFrequency(int pin) FL_NO_EXCEPT;

int pwmEnd(int pin) FL_NO_EXCEPT;
 
}  // namespace fl