Speeduino
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
IgnitionSchedule Struct Reference

#include <scheduler.h>

Inheritance diagram for IgnitionSchedule:
Inheritance graph
[legend]
Collaboration diagram for IgnitionSchedule:
Collaboration graph
[legend]

Public Member Functions

constexpr Schedule (counter_t &counter, compare_t &compare)
 Construct a new Schedule object.
 
- Public Member Functions inherited from Schedule
constexpr Schedule (counter_t &counter, compare_t &compare)
 Construct a new Schedule object.
 

Public Attributes

volatile COMPARE_TYPE endCompare
 The counter value of the timer when this will end.
 
volatile unsigned long startTime
 
volatile bool endScheduleSetByDecoder = false
 
- Public Attributes inherited from Schedule
volatile COMPARE_TYPE duration = 0U
 Scheduled duration (timer ticks)
 
volatile ScheduleStatus Status = OFF
 Schedule status: OFF, PENDING, STAGED, RUNNING.
 
voidVoidCallback pStartCallback = &nullCallback
 Start Callback function for schedule.
 
voidVoidCallback pEndCallback = &nullCallback
 End Callback function for schedule.
 
COMPARE_TYPE nextStartCompare = 0U
 Planned start of next schedule (when current schedule is RUNNING)
 
counter_t_counter
 Reference to the counter register. E.g. TCNT3
 
compare_t_compare
 **Reference**to the compare register. E.g. OCR3A
 

Additional Inherited Members

- Public Types inherited from Schedule
using counter_t = decltype(FUEL1_COUNTER)
 The type of a timer counter register (this varies between platforms)
 
using compare_t = decltype(FUEL1_COMPARE)
 The type of a timer compare register (this varies between platforms)
 

Detailed Description

Ignition schedule.

Member Function Documentation

◆ Schedule()

constexpr Schedule::Schedule ( counter_t counter,
compare_t compare 
)
inlineconstexpr

Construct a new Schedule object.

Parameters
counterA reference to the timer counter
compareA reference to the timer comparator

Member Data Documentation

◆ endCompare

volatile COMPARE_TYPE IgnitionSchedule::endCompare

The counter value of the timer when this will end.

◆ endScheduleSetByDecoder

volatile bool IgnitionSchedule::endScheduleSetByDecoder = false

◆ startTime

volatile unsigned long IgnitionSchedule::startTime

The system time (in uS) that the schedule started, used by the overdwell protection in timers.ino


The documentation for this struct was generated from the following file: