pages.h File Reference

#include <Arduino.h>
#include "table3d.h"
#include "config_pages.h"

This graph shows which files directly or indirectly include this file:

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_page_address_t
	Position and size of an entity within a page. More...
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 offset)
	Gets a single value from a page, with data aligned as per the ini file.
bool	setPageValue (uint8_t pageNum, uint16_t offset, byte value)
	Sets a single value from a page, with data aligned as per the ini file.
byte	getEntityValue (const page_iterator_t &entity, uint16_t offset)
	Gets a single value from an entity, with data aligned as per the ini file.
bool	setEntityValue (page_iterator_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)
page_iterator_t	advance (const page_iterator_t &it)
table_value_iterator	rows_begin (const page_iterator_t &it)
table_axis_iterator	x_begin (const page_iterator_t &it)
table_axis_iterator	x_rbegin (const page_iterator_t &it)
table_axis_iterator	y_begin (const page_iterator_t &it)

Variables
constexpr uint8_t	veMapPage = 2
constexpr uint8_t	veSetPage = 1
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)

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]

it

The current iterator

Here is the call graph for this function:

Here is the caller graph for this function:

getEntityValue()

byte getEntityValue	(	const page_iterator_t &	entity,
		uint16_t	offset
	)

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

Parameters

[in]	entity	The entity to update
[in]	offset	The offset within the entity

Here is the call graph for this function:

Here is the caller graph for this function:

getPageSize()

uint16_t getPageSize

(

uint8_t

pageNum

)

Page size in bytes

Parameters

[in]

pageNum

The page number

Here is the call graph for this function:

Here is the caller graph for this function:

getPageValue()

byte getPageValue	(	uint8_t	pageNum,
		uint16_t	offset
	)

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

Parameters

[in]	pageNum	The page number to retrieve data from.
[in]	offset	The address in the page that should be returned. This is as per the page definition in the ini.

Here is the call graph for this function:

Here is the caller graph for this function:

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]

pageNum

The page number to iterate over.

Here is the call graph for this function:

Here is the caller graph for this function:

rows_begin()

table_value_iterator rows_begin

(

const page_iterator_t &

it

)

Convert page iterator to table value iterator.

Here is the call graph for this function:

Here is the caller graph for this function:

setEntityValue()

bool setEntityValue	(	page_iterator_t &	entity,
		uint16_t	offset,
		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]	entity	The entity to update
[in]	offset	The offset within the entity
[in]	value	The new value

Here is the call graph for this function:

Here is the caller graph for this function:

setPageValue()

bool setPageValue	(	uint8_t	pageNum,
		uint16_t	offset,
		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]	pageNum	The page number to update.
[in]	offset	The offset within the page.
[in]	value	The new value

Here is the call graph for this function:

Here is the caller graph for this function:

setTuneToEmpty()

void setTuneToEmpty

(

void

)

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

Here is the call graph for this function:

Here is the caller graph for this function:

x_begin()

table_axis_iterator x_begin

(

const page_iterator_t &

it

)

Convert page iterator to table x axis iterator.

Here is the call graph for this function:

Here is the caller graph for this function:

x_rbegin()

table_axis_iterator x_rbegin

(

const page_iterator_t &

it

)

Convert page iterator to table x axis iterator.

Here is the call graph for this function:

Here is the caller graph for this function:

y_begin()

table_axis_iterator y_begin

(

const page_iterator_t &

it

)

Convert page iterator to table y axis iterator.

Here is the call graph for this function:

Here is the caller graph for this function:

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

fuelMap2Page

constexpr uint8_t fuelMap2Page = 11

constexpr

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

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