Speeduino
Loading...
Searching...
No Matches
Classes | Enumerations | Functions | Variables
pages.h File Reference
#include <Arduino.h>
#include "table3d.h"
#include "config_pages.h"

Go to the source code of this file.

Classes

struct  entity_page_location_t
 The unique location of an entity within all pages. More...
 
struct  entity_t
 
struct  page_entity_t
 
struct  page_iterator_t
 

Enumerations

enum class  EntityType : uint8_t { Raw , Table , NoEntity , End }
 

Functions

uint16_t getPageSize (uint8_t pageNum)
 
void setTuneToEmpty (void)
 Fill the tune (config pages & tables) with zeroes.
 
byte getPageValue (uint8_t pageNum, uint16_t pageOffset)
 Gets a single value from a page, with data aligned as per the ini file.
 
bool setPageValue (uint8_t pageNum, uint16_t pageOffset, byte value)
 Sets a single value from a page, with data aligned as per the ini file.
 
byte getEntityValue (const entity_t &entity, uint16_t offset)
 Gets a single value from an entity, with data aligned as per the ini file.
 
bool setEntityValue (entity_t &entity, uint16_t offset, byte value)
 Sets a single value from a page, with data aligned as per the ini file.
 
page_iterator_t page_begin (uint8_t pageNum)
 Initiates iteration over a pages entities.
 
page_iterator_t advance (const page_iterator_t &it)
 Moves the iterator to the next sub-entity on the page.
 

Variables

constexpr uint8_t veSetPage = 1
 
constexpr uint8_t veMapPage = 2
 
constexpr uint8_t ignMapPage = 3
 
constexpr uint8_t ignSetPage = 4
 
constexpr uint8_t afrMapPage = 5
 
constexpr uint8_t afrSetPage = 6
 
constexpr uint8_t boostvvtPage = 7
 
constexpr uint8_t seqFuelPage = 8
 
constexpr uint8_t canbusPage = 9
 
constexpr uint8_t warmupPage = 10
 
constexpr uint8_t fuelMap2Page = 11
 
constexpr uint8_t wmiMapPage = 12
 
constexpr uint8_t progOutsPage = 13
 
constexpr uint8_t ignMap2Page = 14
 
constexpr uint8_t boostvvtPage2 = 15
 
constexpr uint8_t MIN_PAGE_NUM = veSetPage
 
constexpr uint8_t MAX_PAGE_NUM = (boostvvtPage2+1U)
 
Calibration page numbers
constexpr uint8_t O2_CALIBRATION_PAGE = MAX_PAGE_NUM+1
 O2 sensor calibration table page number.
 
constexpr uint8_t IAT_CALIBRATION_PAGE = O2_CALIBRATION_PAGE+1
 IAT sensor calibration table page number.
 
constexpr uint8_t CLT_CALIBRATION_PAGE = IAT_CALIBRATION_PAGE+1
 Coolant sensor calibration table page number.
 
Calibration page sub-indexes
constexpr uint8_t PAGE_IDX_CALIBRATION_CRC = 0
 Index of a calibration table CRC on a "page".
 
constexpr uint8_t PAGE_IDX_CALIBRATION_VALUES = 1
 Index of a calibration table values on a "page".
 
constexpr uint8_t PAGE_IDX_CALIBRATION_BINS = 2
 Index of a calibration table bins on a "page".
 

Enumeration Type Documentation

◆ EntityType

enum class EntityType : uint8_t
strong
Enumerator
Raw 
Table 
NoEntity 
End 

Function Documentation

◆ advance()

page_iterator_t advance ( const page_iterator_t &  it)

Moves the iterator to the next sub-entity on the page.

Parameters
[in]itThe current iterator

◆ getEntityValue()

byte getEntityValue ( const entity_t &  entity,
uint16_t  offset 
)

Gets a single value from an entity, with data aligned as per the ini file.

Parameters
[in]entityThe entity to update
[in]offsetThe offset within the entity

◆ getPageSize()

uint16_t getPageSize ( uint8_t  pageNum)

Page size in bytes

Parameters
[in]pageNumThe page number

◆ getPageValue()

byte getPageValue ( uint8_t  pageNum,
uint16_t  pageOffset 
)

Gets a single value from a page, with data aligned as per the ini file.

Parameters
[in]pageNumThe page number to retrieve data from.
[in]pageOffsetThe address in the page that should be returned. This is as per the page definition in the ini.

◆ page_begin()

page_iterator_t page_begin ( uint8_t  pageNum)

Initiates iteration over a pages entities.

Test entity.type==End to determine the end of the page.

Parameters
[in]pageNumThe page number to iterate over.

◆ setEntityValue()

bool setEntityValue ( entity_t &  entity,
uint16_t  offset,
byte  value 
)

Sets a single value from a page, with data aligned as per the ini file.

Parameters
[in]entityThe entity to update
[in]offsetThe offset within the entity
[in]valueThe new value

◆ setPageValue()

bool setPageValue ( uint8_t  pageNum,
uint16_t  pageOffset,
byte  value 
)

Sets a single value from a page, with data aligned as per the ini file.

Returns
true if value set, false otherwise
Parameters
[in]pageNumThe page number to update.
[in]pageOffsetThe offset within the page.
[in]valueThe new value

◆ setTuneToEmpty()

void setTuneToEmpty ( void  )

Fill the tune (config pages & tables) with zeroes.

Variable Documentation

◆ afrMapPage

constexpr uint8_t afrMapPage = 5
constexpr

◆ afrSetPage

constexpr uint8_t afrSetPage = 6
constexpr

◆ boostvvtPage

constexpr uint8_t boostvvtPage = 7
constexpr

◆ boostvvtPage2

constexpr uint8_t boostvvtPage2 = 15
constexpr

◆ canbusPage

constexpr uint8_t canbusPage = 9
constexpr

◆ CLT_CALIBRATION_PAGE

constexpr uint8_t CLT_CALIBRATION_PAGE = IAT_CALIBRATION_PAGE+1
constexpr

Coolant sensor calibration table page number.

◆ fuelMap2Page

constexpr uint8_t fuelMap2Page = 11
constexpr

◆ IAT_CALIBRATION_PAGE

constexpr uint8_t IAT_CALIBRATION_PAGE = O2_CALIBRATION_PAGE+1
constexpr

IAT sensor calibration table page number.

◆ ignMap2Page

constexpr uint8_t ignMap2Page = 14
constexpr

◆ ignMapPage

constexpr uint8_t ignMapPage = 3
constexpr

◆ ignSetPage

constexpr uint8_t ignSetPage = 4
constexpr

◆ MAX_PAGE_NUM

constexpr uint8_t MAX_PAGE_NUM = (boostvvtPage2+1U)
constexpr

◆ MIN_PAGE_NUM

constexpr uint8_t MIN_PAGE_NUM = veSetPage
constexpr

◆ O2_CALIBRATION_PAGE

constexpr uint8_t O2_CALIBRATION_PAGE = MAX_PAGE_NUM+1
constexpr

O2 sensor calibration table page number.

◆ PAGE_IDX_CALIBRATION_BINS

constexpr uint8_t PAGE_IDX_CALIBRATION_BINS = 2
constexpr

Index of a calibration table bins on a "page".

◆ PAGE_IDX_CALIBRATION_CRC

constexpr uint8_t PAGE_IDX_CALIBRATION_CRC = 0
constexpr

Index of a calibration table CRC on a "page".

◆ PAGE_IDX_CALIBRATION_VALUES

constexpr uint8_t PAGE_IDX_CALIBRATION_VALUES = 1
constexpr

Index of a calibration table values on a "page".

◆ progOutsPage

constexpr uint8_t progOutsPage = 13
constexpr

◆ seqFuelPage

constexpr uint8_t seqFuelPage = 8
constexpr

◆ veMapPage

constexpr uint8_t veMapPage = 2
constexpr

◆ veSetPage

constexpr uint8_t veSetPage = 1
constexpr

◆ warmupPage

constexpr uint8_t warmupPage = 10
constexpr

◆ wmiMapPage

constexpr uint8_t wmiMapPage = 12
constexpr
Generated by doxygen 1.9.8