Light hardware abstraction layer for peripherals. More...

#include <Arduino.h>
#include <stdint.h>
#include <stdio.h>
#include <stdarg.h>
#include <Wire.h>
#include <SPI.h>

Include dependency graph for hV_SDK_Peripherals.h:

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

Macros
#define	hV_SDK_PERIPHERALS_RELEASE 902
	Release.

Specific configuration
SDK library See also References Arduino SDK https://www.arduino.cc/reference/en/ Energia SDK https://energia.nu/reference/ Linux no SDK Other libraries
#define	hV_SDK_Serial Serial
	FRAM management.

#define	hV_SDK_Serial_Speed 115200
	Serial port speed.


#define	hV_SDK_Wire Wire
	Wire configuration.


#define	hV_SDK_SPI SPI
	SPI configuration.

#define	SPI_SPEED_4_MHz 4000000
	SPI speed.

#define	SPI_SPEED_8_MHz 8000000
	SPI configuration.

#define	SPI_SPEED_16_MHz 16000000
	SPI configuration.

#define	hV_SDK_SPI_SPEED SPI_SPEED_8_MHz
	SPI configuration.

#define	hV_SDK_SPI_MOSI MOSI
	SPI pins.

#define	hV_SDK_SPI_MISO MISO
	SPI configuration.

#define	hV_SDK_SPI_SCK SCK
	SPI configuration.

Functions
template<typename T>
void	hV_SDK_Serial_print (T text)
	Print to serial console.

template<typename T>
void	hV_SDK_Serial_println (T text)
	Print to serial console with cr-lf at the end.

General
void	hV_SDK_begin ()
	General initialisation.

void	hV_SDK_exit (uint8_t code=0)
	General exit.

GPIO
See also https://www.arduino.cc/reference/en/language/functions/digital-io/
void	hV_SDK_GPIO_begin (void)
	GPIO initialisation.

void	hV_SDK_GPIO_define (uint8_t pin, uint8_t mode)
	Define GPIO mode.

void	hV_SDK_GPIO_write (uint8_t pin, uint8_t value)
	Write GPIO.

uint8_t	hV_SDK_GPIO_read (uint8_t pin)
	Read GPIO.

Time
See also https://www.arduino.cc/reference/en/#time
void	hV_SDK_delayMicroseconds (uint32_t us)
	Microsecond non-blocking delay.

void	hV_SDK_delayMilliseconds (uint32_t ms)
	Millisecond non-blocking delay.

uint32_t	hV_SDK_getMilliseconds (void)
	Get milliseconds since start-up.

Serial console
Formatted output to hV_SDK_Serial See also https://www.arduino.cc/reference/en/language/functions/communication/serial/
void	hV_SDK_Serial_begin (uint32_t speed=115200)
	Initialise console.

void	hV_SDK_Serial_printf (const char *format, va_list args)
	Format and send to console.

void	hV_SDK_Serial_crlf (void)
	Print carriage-return line-feed.

SPI bus
See also https://www.arduino.cc/en/Reference/SPI Warning Energia does not implement beginTransaction...endTransaction
void	hV_SDK_SPI_begin (uint32_t speed=8000000)
	Configure and start SPI.

void	hV_SDK_SPI_end ()
	End SPI.

uint8_t	hV_SDK_SPI_transfer (uint8_t data)
	Combined write and read of a single byte.

void	hV_SDK_SPI_transfer (uint8_t *data, size_t size)
	Combined write and read.

3-wire SPI bus
Warning Arduino does not support 3-wire PSI, bit-bang simulation Viewer: For compatibility only, not implemented in Linux Note hV_SDK_SPI_begin() calls hV_SDK_SPI3_define().
void	hV_SDK_SPI3_begin ()
	Configure 3-wire SPI.

void	hV_SDK_SPI3_end ()
	End 3-wire SPI.

void	hV_SDK_SPI3_define (uint8_t pinClock=SCK, uint8_t pinData=MOSI)
	Set the 3-wire SPI pins.

uint8_t	hV_SDK_SPI3_read ()
	Read a single byte.

void	hV_SDK_SPI3_write (uint8_t data)
	Write a single byte.

Wire bus
See also https://www.arduino.cc/en/Reference/Wire
void	hV_SDK_Wire_begin ()
	Configure and start Wire bus.

void	hV_SDK_Wire_end ()
	End Wire bus.

void	hV_SDK_Wire_transfer (uint8_t address, uint8_t dataWrite, size_t sizeWrite, uint8_t dataRead=0, size_t sizeRead=0)
	Combined write and read.

Miscellaneous
uint32_t	hV_SDK_random (uint32_t maxNumber)
	Pseudo-random number.

Detailed Description

Light hardware abstraction layer for peripherals.

Project Pervasive Displays Library Suite
Based on highView technology

Author: Rei Vilo

Date: 21 Jan 2025

Version: 902

Copyright: (c) Rei Vilo, 2010-2025; All rights reserved; For exclusive use with Pervasive Displays screens

Evaluation edition: for professionals or organisations, evaluation only, no commercial usage
Commercial edition: for professionals or organisations, commercial usage

Deprecated
Removed synonyms for GPIO (7.0.0)

Deprecated
Removed synonyms for Time (7.0.0)

Deprecated
Removed synonyms for Serial (7.0.0)

Deprecated
Removed synonyms for SPI (7.0.0)

Deprecated
Removed synonyms for Wire (7.0.0)

Macro Definition Documentation

◆ hV_SDK_Serial

#define hV_SDK_Serial Serial

FRAM management.

for MSP430FR MCUs

Serial configuration

Serial port

◆ hV_SDK_Serial_Speed

#define hV_SDK_Serial_Speed 115200

Serial port speed.

Recommended 115200

◆ hV_SDK_SPI

#define hV_SDK_SPI SPI

SPI configuration.

SPI bus

◆ hV_SDK_SPI_MISO

#define hV_SDK_SPI_MISO MISO

SPI configuration.

SPI bus

◆ hV_SDK_SPI_MOSI

#define hV_SDK_SPI_MOSI MOSI

SPI pins.

For default SPI3 configuration

◆ hV_SDK_SPI_SCK

#define hV_SDK_SPI_SCK SCK

SPI configuration.

SPI bus

◆ hV_SDK_SPI_SPEED

#define hV_SDK_SPI_SPEED SPI_SPEED_8_MHz

SPI configuration.

SPI bus

◆ hV_SDK_Wire

#define hV_SDK_Wire Wire

Wire configuration.

Wire bus

◆ SPI_SPEED_16_MHz

#define SPI_SPEED_16_MHz 16000000

SPI configuration.

SPI bus

◆ SPI_SPEED_4_MHz

#define SPI_SPEED_4_MHz 4000000

SPI speed.

Recommended 4 MHz, safe up to 8 MHz

Warning: Check hardware and other SPI connected devices

◆ SPI_SPEED_8_MHz

#define SPI_SPEED_8_MHz 8000000

SPI configuration.

SPI bus

Function Documentation

◆ hV_SDK_begin()

void hV_SDK_begin ( )

General initialisation.

hV_SDK_Serial initialised at hV_SDK_Serial_Speed

◆ hV_SDK_delayMicroseconds()

void hV_SDK_delayMicroseconds ( uint32_t us )

Microsecond non-blocking delay.

Parameters

us delay, us

◆ hV_SDK_delayMilliseconds()

void hV_SDK_delayMilliseconds ( uint32_t ms )

Millisecond non-blocking delay.

Parameters

ms delay, ms

◆ hV_SDK_exit()

void hV_SDK_exit ( uint8_t code = 0 )

General exit.

Parameters

code	default = 0 = success, otherwise error

Note: Only used on Linux

◆ hV_SDK_getMilliseconds()

uint32_t hV_SDK_getMilliseconds ( void )

Get milliseconds since start-up.

Returns: uint32_t milliseconds since start-up

Note: Limit of 2^32 ms or ~49.7 days

◆ hV_SDK_GPIO_begin()

void hV_SDK_GPIO_begin ( void )

GPIO initialisation.

Required for GPIO expander

Warning: begin() does not initialise SPI; begin() initialises I2C

◆ hV_SDK_GPIO_define()

void hV_SDK_GPIO_define	(	uint8_t	pin,
		uint8_t	mode )

Define GPIO mode.

Parameters

pin	pin number

Note: Same as hV_SDK_GPIO_pinMode(pin, mode);

◆ hV_SDK_GPIO_read()

uint8_t hV_SDK_GPIO_read ( uint8_t pin )

Read GPIO.

Parameters

pin	pin number

Returns: uint8_t HIGH = true or LOW = false

Note: Synonym of hV_SDK_GPIO_get();

◆ hV_SDK_GPIO_write()

void hV_SDK_GPIO_write	(	uint8_t	pin,
		uint8_t	value )

Write GPIO.

Parameters

pin	pin number
value	HIGH = true or LOW = false

Note: Synonym of hV_SDK_GPIO_set() and hV_SDK_GPIO_clear()

◆ hV_SDK_random()

uint32_t hV_SDK_random ( uint32_t maxNumber )

Pseudo-random number.

Parameters

maxNumber maximum random number

Returns: uint32_t 0..number - 1

◆ hV_SDK_Serial_begin()

void hV_SDK_Serial_begin ( uint32_t speed = 115200 )

Initialise console.

Parameters

speed in bps, eg. 115200

Deprecated: Console already initialised at 115200 by hV_SDK_begin() (6.0.7)

◆ hV_SDK_Serial_print()

template<typename T>

void hV_SDK_Serial_print ( T text )

Print to serial console.

Template Parameters

T	type of the element, [u]int{8\|16\|32}_t float String char*

Parameters

text	element to print

Warning: Because of <template>, code follows definition in header file

Deprecated: Use hV_HAL_Serial_printf() and hV_HAL_Serial_crlf() instead (6.1.0)

◆ hV_SDK_Serial_printf()

void hV_SDK_Serial_printf	(	const char *	format,
		va_list	args )

Format and send to console.

Parameters

format	see https://www.cplusplus.com/reference/cstdio/printf/ for tokens
args	explicit variadic list required for hV_HAL_Serial_printf()

◆ hV_SDK_Serial_println()

template<typename T>

void hV_SDK_Serial_println ( T text )

Print to serial console with cr-lf at the end.

Template Parameters

T	type of the element: [u]int{8\|16\|32}_t float String char*

Parameters

text	element to print

Warning: Because of <template>, code follows definition in header file

Deprecated: Use hV_HAL_Serial_printf() and hV_HAL_Serial_crlf() instead (6.1.0)

◆ hV_SDK_SPI3_define()

void hV_SDK_SPI3_define	(	uint8_t	pinClock = SCK,
		uint8_t	pinData = MOSI )

Set the 3-wire SPI pins.

Parameters

pinClock	clock, default = SCK
pinData	combined data, default = MOSI

Note: Called by hV_SDK_SPI_begin()

◆ hV_SDK_SPI3_read()

uint8_t hV_SDK_SPI3_read ( )

Read a single byte.

Returns: read byte

Note: Configure the clock pin as output and data pin as input.

Warning: /CS to be managed externally.

◆ hV_SDK_SPI3_write()

void hV_SDK_SPI3_write ( uint8_t data )

Write a single byte.

Parameters

data byte

Note: Configure the clock and data pins as output.

Warning: /CS to be managed externally.

◆ hV_SDK_SPI_begin()

void hV_SDK_SPI_begin ( uint32_t speed = 8000000 )

Configure and start SPI.

Parameters

speed SPI speed in Hz, hV_HAL_SPI_SPEED = default Other values are SPI_SPEED_4_MHz, SPI_SPEED_8_MHz, SPI_SPEED_16_MHz

Note

Other parameters are

Bit order: MSBFIRST
Data mode: SPI_MODE0

Warning: SPI ESP32 uses pins SCK = 14, MISO = 12 and MOSI = 13

Note: Check for unique initialisation

◆ hV_SDK_SPI_end()

void hV_SDK_SPI_end ( )

End SPI.

Note: Check for unique deinitialisation

◆ hV_SDK_SPI_transfer() [1/2]

void hV_SDK_SPI_transfer	(	uint8_t *	data,
		size_t	size )

Combined write and read.

Parameters

data	array of uint8_t to send
size	length

Note: Array may be updated with read data

Warning: No check for previous initialisation

◆ hV_SDK_SPI_transfer() [2/2]

uint8_t hV_SDK_SPI_transfer ( uint8_t data )

Combined write and read of a single byte.

Parameters

data byte

Returns: read byte

Warning: No check for previous initialisation

◆ hV_SDK_Wire_begin()

void hV_SDK_Wire_begin ( )

Configure and start Wire bus.

Note: Master mode only; Check for unique initialisation

◆ hV_SDK_Wire_end()

void hV_SDK_Wire_end ( )

End Wire bus.

Note: Check for unique deinitialisation

◆ hV_SDK_Wire_transfer()

void hV_SDK_Wire_transfer	(	uint8_t	address,
		uint8_t *	dataWrite,
		size_t	sizeWrite,
		uint8_t *	dataRead = 0,
		size_t	sizeRead = 0 )

Combined write and read.

Parameters

[in]	address	I2C device address
[in]	dataWrite	buffer to write
[in]	sizeWrite	number of bytes
[out]	dataRead	buffer to read
[in]	sizeRead	number of bytes

Note: If sizeRead = 0, no read performed

Warning: No check for previous initialisation

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ hV_SDK_Serial

◆ hV_SDK_Serial_Speed

◆ hV_SDK_SPI

◆ hV_SDK_SPI_MISO

◆ hV_SDK_SPI_MOSI

◆ hV_SDK_SPI_SCK

◆ hV_SDK_SPI_SPEED

◆ hV_SDK_Wire

◆ SPI_SPEED_16_MHz

◆ SPI_SPEED_4_MHz

◆ SPI_SPEED_8_MHz

Function Documentation

◆ hV_SDK_begin()

◆ hV_SDK_delayMicroseconds()

◆ hV_SDK_delayMilliseconds()

◆ hV_SDK_exit()

◆ hV_SDK_getMilliseconds()

◆ hV_SDK_GPIO_begin()

◆ hV_SDK_GPIO_define()

◆ hV_SDK_GPIO_read()

◆ hV_SDK_GPIO_write()

◆ hV_SDK_random()

◆ hV_SDK_Serial_begin()

◆ hV_SDK_Serial_print()

◆ hV_SDK_Serial_printf()

◆ hV_SDK_Serial_println()

◆ hV_SDK_SPI3_define()

◆ hV_SDK_SPI3_read()

◆ hV_SDK_SPI3_write()

◆ hV_SDK_SPI_begin()

◆ hV_SDK_SPI_end()

◆ hV_SDK_SPI_transfer() [1/2]

◆ hV_SDK_SPI_transfer() [2/2]

◆ hV_SDK_Wire_begin()

◆ hV_SDK_Wire_end()

◆ hV_SDK_Wire_transfer()