mock::Mock Class Reference

Arduino Mock methods and mocked Arduino language constructs. More...

#include <Mock.h>

Public Member Functions
	Mock (void)
	Constructor.
	~Mock (void)
	Deallocate Mock object.

Static Public Member Functions
static uint16_t	digitalRead (uint8_t pin)
	Mocked Arduino digitalRead(). More...
static void	digitalWrite (uint8_t pin, uint8_t value)
	Mocked Arduino digitalWrite() returns without action. More...
static void	pinMode (uint8_t pin, uint8_t mode)
	Mocked Arduino pinMode() returns without action. More...
static uint16_t	analogRead (uint8_t pin)
	Mocked Arduino analogRead(). More...
static void	analogWrite (uint8_t pin, uint16_t value)
	Mocked Arduino analogWrite() returns without action. More...
static uint32_t	millis (void)
	Mocked Arduino millis(). More...
static uint32_t	micros (void)
	Mocked Arduino micros(). More...
static void	delay (uint32_t ms_delay)
	Mocked Arduino delay(). More...
static void	delayMicroseconds (uint32_t us_delay)
	Mocked Arduino delayMicroseconds(). More...
static uint32_t	map (uint32_t in_value, uint32_t in_min, uint32_t in_max, uint32_t out_min, uint32_t out_max)
	Re-maps a number from one range to another. That is, a value of in_min would get mapped to out_min, a value of in_max to out_max, values in-between to values in-between, etc. More...
static uint16_t	read (uint16_t address)
	Mocked EEPROM read(). More...
static void	write (uint16_t address, uint16_t value)
	Mocked EEPROM write() returns without action. More...
static void	update (uint16_t address, uint16_t value)
	Mocked EEPROM update() returns without action. More...
static uint16_t	get (uint16_t address, uint16_t data)
	Mocked EEPROM get(). More...
static void	put (uint16_t address, uint16_t data)
	Mocked EEPROM put(). More...
static uint16_t	length (void)
	Mocked EEPROM length(). More...
static uint16_t	begin (void)
	Mocked EEPROM begin(). More...
static uint16_t	end (void)
	Mocked EEPROM end(). More...

Detailed Description

Arduino Mock methods and mocked Arduino language constructs.

Member Function Documentation

digitalRead()

static uint16_t mock::Mock::digitalRead ( uint8_t  pin )

inlinestatic

Mocked Arduino digitalRead().

Parameters

pin	The digital pin to read from.

Returns

The mocked digitalRead() value, i.e., zero.

digitalWrite()

static void mock::Mock::digitalWrite ( uint8_t  pin, uint8_t  value  )

inlinestatic

Mocked Arduino digitalWrite() returns without action.

Parameters

pin	Arduino pin number for write.
value	Value is either HIGH or LOW.

pinMode()

static void mock::Mock::pinMode ( uint8_t  pin, uint8_t  mode  )

inlinestatic

Mocked Arduino pinMode() returns without action.

Parameters

pin	Arduino pin number to set the mode.
mode	Sets the mode to INPUT, OUTPUT, or INPUT_PULLUP.

analogRead()

static uint16_t mock::Mock::analogRead ( uint8_t  pin )

inlinestatic

Mocked Arduino analogRead().

Parameters

pin	The analog pin to read from.

Returns

The mocked analogRead() value, i.e., zero.

analogWrite()

static void mock::Mock::analogWrite ( uint8_t  pin, uint16_t  value  )

inlinestatic

Mocked Arduino analogWrite() returns without action.

Parameters

pin	The analog pin to write to.
value	The duty cycle: between 0 (off) and 255 (on).

millis()

static uint32_t mock::Mock::millis ( void  )

inlinestatic

Mocked Arduino millis().

Returns

Returns 0.

micros()

static uint32_t mock::Mock::micros ( void  )

inlinestatic

Mocked Arduino micros().

Returns

Returns 0.

delay()

static void mock::Mock::delay ( uint32_t  ms_delay )

inlinestatic

Mocked Arduino delay().

Parameters

ms_delay

The time to pause the code execution.

delayMicroseconds()

static void mock::Mock::delayMicroseconds ( uint32_t  us_delay )

inlinestatic

Mocked Arduino delayMicroseconds().

Parameters

us_delay

The time to pause the code execution.

map()

static uint32_t mock::Mock::map ( uint32_t  in_value, uint32_t  in_min, uint32_t  in_max, uint32_t  out_min, uint32_t  out_max  )

inlinestatic

Re-maps a number from one range to another. That is, a value of in_min would get mapped to out_min, a value of in_max to out_max, values in-between to values in-between, etc.

Parameters

in_value	The in value to map.
in_min	The lower bound of the value’s current range.
in_max	The upper bound of the value’s current range.
out_min	The lower bound of the value’s target range.
out_max	The upper bound of the value’s target range.

Returns

The mapped value.

read()

static uint16_t mock::Mock::read ( uint16_t  address )

inlinestatic

Mocked EEPROM read().

Parameters

address

Read a byte from EEPROM address.

Returns

The mocked read() value, i.e., zero.

write()

static void mock::Mock::write ( uint16_t  address, uint16_t  value  )

inlinestatic

Mocked EEPROM write() returns without action.

Parameters

address	The EEPROM address to write a byte.
value	The value (byte) to write at that address.

update()

static void mock::Mock::update ( uint16_t  address, uint16_t  value  )

inlinestatic

Mocked EEPROM update() returns without action.

Parameters

address	The EEPROM address to write a byte.
value	The value to write (byte), if different at that address.

get()

static uint16_t mock::Mock::get ( uint16_t  address, uint16_t  data  )

inlinestatic

Mocked EEPROM get().

Parameters

address	Read from EEPROM address.
data	Read any data type or object from the EEPROM.

Returns

The mocked get() value, i.e., zero.

put()

static void mock::Mock::put ( uint16_t  address, uint16_t  data  )

inlinestatic

Mocked EEPROM put().

Parameters

address	The EEPROM address to write a byte.
data	Write data to EEPROM address.

length()

static uint16_t mock::Mock::length ( void  )

inlinestatic

Mocked EEPROM length().

Returns

The mocked length() value, i.e., zero.

begin()

static uint16_t mock::Mock::begin ( void  )

inlinestatic

Mocked EEPROM begin().

Returns

The mocked begin() value, i.e., hex zero.

end()

static uint16_t mock::Mock::end ( void  )

inlinestatic

Mocked EEPROM end().

Returns

The mocked end() value, i.e., zero length.

---

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

• Mock.h