- Generated by
1.9.4
|
SensESP 2.6.0
Universal Signal K sensor toolkit ESP32
|
| ►Nsensesp | |
| CAirDensity | Transforms temperature, relative humidity and pressure in air density |
| CAnalogInput | Sensor for reading the MCU analog input pins |
| CAnalogVoltage | A transform that takes the output of an analog-to-digital converter and outputs the voltage that went into it. (This can be the built-in ADC on the ESP, or it can be an external ADC like the ADS1015/1115.) |
| CAngleCorrection | Add a value to an angle input (in radians). The output value is wrapped to a range between [0, 2*pi]. This transform is useful for correcting e.g. a heading or a wind direction reading |
| CBaseAnalogReader | Used by AnalogInput as a hardware abstraction layer |
| CBaseBlinker | A base class for LED blinker classes |
| CChangeFilter | A float passthrough transform that will only pass that value through if it is "sufficiently different" from the last value passed through |
| CClickType | ClickType is a transform that consumes button clicks and translates them as events of type ClickTypes |
| CConfigurable | An object that is capable of having configuration data that can be set remotely using a RESTful API, and can be persisted to the local file system |
| ►CCurveInterpolator | Implement a piecewise linear interpolation transform |
| CSample | |
| CDebounceTemplate | Implements debounce code for a button or switch |
| CDebugOutput | Initialize logging/debug output |
| CDewPoint | Transforms temperature and relative humidity in dew point temperature |
| CDifference | |
| CDigitalInput | DigitalInput is the base class for reading a digital GPIO pin |
| CDigitalInputChange | DigitalInputChange provides output whenever a digital pin changes its state |
| CDigitalInputCounter | DigitalInputCounter counts interrupts and reports the count every read_delay ms |
| CDigitalInputDebounceCounter | DigitalInputDebounceCounter counts interrupts and reports the count every read_delay ms, but ignores events that happen within ignore_interval_ms |
| CDigitalInputState | DigitalInputState polls the state of an input pin every read_delay ms |
| CDigitalOutput | Sets a GPIO pin to whatever the input is (true = HIGH, false = LOW), and passes the value on to the next ValueConsumer |
| CEnable | On/off switch for signals: input is emitted as-is if the enable flag is set in the web UI |
| CENUVector | Container for local tangent plane coordinates |
| CESP32AnalogReader | |
| CEvenBlinker | An LED blinker class that blinks the LED 50% off, 50% on, at a given period |
| CFilesystem | |
| CFloatThreshold | Translates a float value into a boolean value, which depends on whether the float value is "in range" or "out of range" |
| CFreeMem | Reports the current amount of unused memory of the ESP |
| CFrequency | Transforms its input into frequency (Hz: cycles per second) |
| CHeatIndexEffect | Transforms heat index temperature to heat index effect |
| CHeatIndexTemperature | Transforms temperature and relative humidity in heat index temperature |
| CHTTPServer | Handles external interactions with the device via the web interface |
| CHysteresis | Hysteresis function |
| CIntegratorT | Integrator integrates (accumulates) the incoming values |
| CIntThreshold | Translates an integer value into a boolean value, which depends on whether the integer value is "in range" or "out of range" |
| CIPAddrDev | Reports the IP address of the ESP once it's connected to wifi |
| CLambdaConsumer | Provides an easy way of calling a function based on the output of any ValueProducer |
| CLambdaTransform | Construct a new transform based on a single function |
| CLinear | Performs a linear transform on the input value: output = (input * multiplier) + offset |
| CLocalDebug | |
| CMDNSDiscovery | |
| CMedian | Outputs the median value of sample_size inputs |
| CMovingAverage | Outputs the moving average of the last sample_size inputs |
| CNetworking | Manages the ESP's connection to the Wifi network |
| CObservable | A base class which allow observers to attach callbacks to themselves. The callbacks will be called when the observable needs to notify the observers about some state change |
| CObservableValue | A value that notifies its observers if it gets changed |
| COTA | |
| CParamInfo | |
| CPatternBlinker | A blinker that blinks the LED according to a defined repeating pattern |
| CPeriodicBlinker | A base class for periodic blinkers |
| CPosition | Position data container |
| CPressRepeater | A transform that takes boolean inputs and adds button behaviors familiar to many device end users |
| CPWMOutput | Provides a cross platform mechanism for generating Pulse Width Modulation signals over one or more GPIO pins on the MCU |
| CRatioBlinker | A periodic blinker that defines both the on-ratio and the period length |
| CRepeatReport | Ensures that values that do not change frequently are still reported at a specified maximum silence interval. If the value has not changed in max_silence_interval milliseconds, the current value is emmitted again |
| CRepeatSensor | |
| CResettable | Automatic calling of the reset() method when the device needs to be reset |
| CResettableCompare | |
| CRgbLed | A special device object that can be used to control a multi-channel color rgb LED light using up to 3 digital output channels. A "color" is defined using the standard 24 bit color depth numbers composed of three 8 bit channels for Red, Green, and Blue (see https://techterms.com/definition/rgb) |
| CRoundToInt | Takes as its input a float, rounds it to the nearest whole number, then outputs it as an int |
| CSensESPApp | |
| CSensESPAppBuilder | A class for quickly configuring a SensESP application object before wiring up your sensors |
| CSensESPBaseApp | The base class for SensESP applications |
| CSensESPBaseAppBuilder | Abstract base class for other SensESP*AppBuilder classes |
| CSensESPMinimalApp | |
| CSensESPMinimalAppBuilder | |
| CSensor | The base class for all sensors. Used only as a base class - never instantiated directly in a project |
| CSensorT | Sensor template class for any sensor producing actual values |
| CSKDeltaQueue | Signal K delta queue |
| CSKEmitter | A class that produces Signal K output to be forwarded to the Signal K server (if the system is connected to one). Signal K is reported via the as_signalK() method |
| CSKListener | An Obervable class that listens for Signal K stream deltas and notifies any observers of value changes. This serves as a base class for code that needs to listen to the stream, with the most common descendant being SKValueListener |
| CSKMetadata | Holds Signal K meta data that is associated with the sk_path an SKEmitter class may optionally send to the server. According to the official Signal K specification: "All keys in the Signal K specification must have a <tt>description</tt>, and where the key is a numeric value it must have <tt>units</tt>". Thus, any paths that you output that are not already part of the official Signal K specification should have these two fields defined as metadata |
| CSKOutput | A specialized transform whose primary purpose is to output Signal K data on the Signal K network |
| CSKOutputNumeric | A special class for sending numeric values to the Signal K server on a specific Signal K path |
| CSKOutputRawJson | Class for sending raw Json strings on a specific Signal K path |
| CSKOutputTime | |
| CSKPutListener | An Obervable class that listens for Signal K PUT requests coming over the websocket connection and notifies observers of the change |
| CSKPutRequest | Used to send requests to the server to change the value of the specified path to a specific value according to the specification at https://signalk.org/specification/1.5.0/doc/put.html |
| CSKPutRequestBase | A base class for all template variations of the PUT request class SKPutRequest. This base class keeps the compiler from generating reduntant object code for common functionality of each template version |
| CSKPutRequestListener | An object that listens for PUT requests to come in for the specified SignalK path. The value is then emitted for further processing |
| ►CSKRequest | A base class for all objects that are capable of sending "requests" to the SignalK server (and optionally receiving the responses) according to the specification located at https://signalk.org/specification/1.5.0/doc/request_response.html |
| CPendingRequest | |
| CSKValueListener | An ValueProducer that listens to specific Signal K paths and emits its value whenever it changes |
| ►CSmartSwitchController | A high level transform designed to control a digital output (such as a relay) via manual button presses or programatic commands |
| CSyncPath | Used to store configuration internally |
| CStartable | Automatic calling of the start() method at startup |
| CStartableCompare | |
| CSymmetricTransform | A common type of transform that consumes, transforms, then outputs values of the same data type |
| CSystemHz | Reports the current clock speed of the ESP |
| CSystemStatusController | Base class for a controller that can react to system status events |
| CSystemStatusLed | Consumes the networking and websocket states and delta counts and updates the device LED accordingly. Inherit this class and override the methods to customize the behavior |
| CTaskQueueProducer | Producer class that works across task boundaries |
| CTextToTruth | Consumes a string and outputs boolean "true" if the text represents a human readable version of "true" |
| CThresholdTransform | A Transform base class that translates the value of type C into value of type P. Base class for classes FloatThreshold and IntThreshold |
| CTimeString | Consumes a time_t time object and produces a human readable string of the time for UTC in ISO 8601 format |
| CTransform | The main Transform class. A transform is identified primarily by the type of value that is produces (i.e. a Transform<float> is a ValueProducer<float> that generates float values) |
| CTransformBase | The base class for all transforms. A transforms takes a value in, transforms it in some way, and outputs the transformed value |
| CTruthToText | Consumes a boolean value and outputs one the appropriate truth string specified in the constructor. This is the inverse of TextToTruth |
| CTypecast | Converts input from one data type to another, then outputs the new type |
| CUIButton | UIButton implements a button interface on the web UI |
| CUILambdaOutput | |
| CUIOutput | |
| CUIOutputBase | |
| CUptime | Reports the number of seconds since the last restart of the ESP |
| CValueConsumer | A base class for piece of code (like a transform) that accepts data for input. ValueConsumers can accept one or more input values via the set_input() method. They are connected to ValueProducers via the connect_to() method |
| CValueProducer | A base class for any sensor or piece of code that outputs a value for consumption elsewhere |
| CVoltageDividerR1 | Uses the voltage divider formula to calculate (and output) the resistance of R1 in the circuit |
| CVoltageDividerR2 | Uses the voltage divider formula to calculate (and output) the resistance of R2 in the circuit |
| CVoltageMultiplier | OBSOLETE: Since you can now apply an "output_scale" to the AnalogInput sensor, you don't need this transform anymore. See the description of "output_scale" in analog_input.h |
| CWiFiSignal | Reports the current strength of the wifi signal that the ESP is connected to |
| CWSClient | The websocket connection to the Signal K server |
1.9.4