#include <max7219.h>

Public Types
enum	max7219_register_e { MAX7219_NO_OP = 0, MAX7219_DIGIT_0, MAX7219_DIGIT_1, MAX7219_DIGIT_2, MAX7219_DIGIT_3, MAX7219_DIGIT_4, MAX7219_DIGIT_5, MAX7219_DIGIT_6, MAX7219_DIGIT_7, MAX7219_DECODE_MODE, MAX7219_INTENSITY, MAX7219_SCAN_LIMIT, MAX7219_SHUTDOWN, MAX7219_DISPLAY_TEST = 15 }

enum	max7219_intensity_e { MAX7219_INTENSITY_0 = 0, MAX7219_INTENSITY_1, MAX7219_INTENSITY_2, MAX7219_INTENSITY_3, MAX7219_INTENSITY_4, MAX7219_INTENSITY_5, MAX7219_INTENSITY_6, MAX7219_INTENSITY_7, MAX7219_INTENSITY_8, MAX7219_INTENSITY_9, MAX7219_INTENSITY_A, MAX7219_INTENSITY_B, MAX7219_INTENSITY_C, MAX7219_INTENSITY_D, MAX7219_INTENSITY_E, MAX7219_INTENSITY_F }

enum	max7219_scan_limit_e { MAX7219_SCAN_1 = 0, MAX7219_SCAN_2, MAX7219_SCAN_3, MAX7219_SCAN_4, MAX7219_SCAN_5, MAX7219_SCAN_6, MAX7219_SCAN_7, MAX7219_SCAN_8 }

Public Member Functions
	Max7219 ()
	Constructor for Max7219 Class. More...

void	begin (uint8_t mosi, uint8_t sclk, uint8_t cs)
	use in void setup() More...

void	end ()
	used inplace of destructor More...

uint8_t	set_num_devices (uint8_t num_devices)
	Sets the number of MAX7219 devices being used. Defaults to one. More...

void	set_display_test (void)
	Tests all devices being used. More...

void	clear_display_test (void)
	Stops test. More...

uint8_t	init_device (max7219_configuration_t config)
	initializes specific device in display with given config data More...

void	init_display (max7219_configuration_t config)
	initializes all devices with given config data More...

uint8_t	enable_device (uint8_t device_number)
	enables specific device in display More...

void	enable_display (void)
	enables all device in display More...

uint8_t	disable_device (uint8_t device_number)
	disables specific device in display More...

void	disable_display (void)
	disables all devices in display More...

uint8_t	write_digit (uint8_t device_number, uint8_t digit, uint8_t data)
	writes digit of given device with given data, user must enter correct data for decode_mode chosen More...

uint8_t	clear_digit (uint8_t device_number, uint8_t digit)
	clears digit of given device More...

uint8_t	device_all_on (uint8_t device_number)
	turns on all segments/digits of given device More...

uint8_t	device_all_off (uint8_t device_number)
	turns off all segments/digits of given device More...

void	display_all_on (void)
	turns on all segments/digits of display More...

void	display_all_off (void)
	turns off all segments/digits of display More...

Member Enumeration Documentation

enum Max7219::max7219_intensity_e

Enumerator
MAX7219_INTENSITY_0
MAX7219_INTENSITY_1
MAX7219_INTENSITY_2
MAX7219_INTENSITY_3
MAX7219_INTENSITY_4
MAX7219_INTENSITY_5
MAX7219_INTENSITY_6
MAX7219_INTENSITY_7
MAX7219_INTENSITY_8
MAX7219_INTENSITY_9
MAX7219_INTENSITY_A
MAX7219_INTENSITY_B
MAX7219_INTENSITY_C
MAX7219_INTENSITY_D
MAX7219_INTENSITY_E
MAX7219_INTENSITY_F

enum Max7219::max7219_register_e

Enumerator
MAX7219_NO_OP
MAX7219_DIGIT_0
MAX7219_DIGIT_1
MAX7219_DIGIT_2
MAX7219_DIGIT_3
MAX7219_DIGIT_4
MAX7219_DIGIT_5
MAX7219_DIGIT_6
MAX7219_DIGIT_7
MAX7219_DECODE_MODE
MAX7219_INTENSITY
MAX7219_SCAN_LIMIT
MAX7219_SHUTDOWN
MAX7219_DISPLAY_TEST

enum Max7219::max7219_scan_limit_e

Enumerator
MAX7219_SCAN_1
MAX7219_SCAN_2
MAX7219_SCAN_3
MAX7219_SCAN_4
MAX7219_SCAN_5
MAX7219_SCAN_6
MAX7219_SCAN_7
MAX7219_SCAN_8

Constructor & Destructor Documentation

Max7219::Max7219 ( )

Constructor for Max7219 Class.

On Entry:

On Exit:

Returns: none

Member Function Documentation

void Max7219::begin	(	uint8_t	mosi,
		uint8_t	sclk,
		uint8_t	cs
	)

use in void setup()

initializes given pins for use with 'shiftout'

On Entry:

Parameters

[in]	mosi	- pin to use for mosi
[in]	sclk	- pin to use for sclk
[in]	cs	- pin to use for cs

On Exit:

Returns: none

uint8_t Max7219::clear_digit	(	uint8_t	device_number,
		uint8_t	digit
	)

clears digit of given device

On Entry:

Parameters

[in]	device_number	- device to write too
[in]	digit	- digit to clear

On Exit:

Returns: returns 0 on success, returns 1 if device number is > _num_devices returns 2 if device number is 0 returns 3 if digit > 8 returns 4 if digit < 1 returns 0xFF if function just returns

void Max7219::clear_display_test ( void )

Stops test.

Clear bit0 of DISPLAY_TEST regiser in all devices

On Entry:

On Exit:

Returns: none

uint8_t Max7219::device_all_off ( uint8_t device_number )

turns off all segments/digits of given device

On Entry:

Parameters

[in] device_number - device to write too

On Exit:

Returns: returns 0 on success, returns 1 if device number is > _num_devices returns 2 if device number is 0 returns 0xFF if function just returns

uint8_t Max7219::device_all_on ( uint8_t device_number )

turns on all segments/digits of given device

On Entry:

Parameters

[in] device_number - device to write too

On Exit:

Returns: returns 0 on success, returns 1 if device number is > _num_devices returns 2 if device number is 0 returns 0xFF if function just returns

uint8_t Max7219::disable_device ( uint8_t device_number )

disables specific device in display

On Entry:

Parameters

[in] device_number - device to disable

On Exit:

Returns: returns 0 on success, returns 1 if device number is > _num_devices returns 2 if device number is 0 returns 0xFF if function just returns

void Max7219::disable_display ( void )

disables all devices in display

On Entry:

On Exit:

Returns: none

void Max7219::display_all_off ( void )

turns off all segments/digits of display

On Entry:

On Exit:

Returns: none

void Max7219::display_all_on ( void )

turns on all segments/digits of display

On Entry:

On Exit:

Returns: none

uint8_t Max7219::enable_device ( uint8_t device_number )

enables specific device in display

On Entry:

Parameters

[in] device_number - device to enable

On Exit:

Returns: returns 0 on success, returns 1 if device number is > _num_devices returns 2 if device number is 0 returns 0xFF if function just returns

void Max7219::enable_display ( void )

enables all device in display

On Entry:

On Exit:

Returns: none

void Max7219::end ( )

used inplace of destructor

On Entry:

On Exit:

Returns: none

uint8_t Max7219::init_device ( max7219_configuration_t config )

initializes specific device in display with given config data

specific device is determined by config.device_number

On Entry:

Parameters

[in] config - Structure containing configuration data of device

On Exit:

Returns: returns 0 on success, returns 1 if device number is > _num_devices returns 2 if device number is 0 returns 0xFF if function just returns

void Max7219::init_display ( max7219_configuration_t config )

initializes all devices with given config data

all devices are configured with given data

On Entry:

Parameters

[in] config - Structure containing configuration data On Exit:

Returns: none

void Max7219::set_display_test ( void )

Tests all devices being used.

Sets bit0 of DISPLAY_TEST regiser in all devices

On Entry:

On Exit:

Returns: none

uint8_t Max7219::set_num_devices ( uint8_t num_devices )

Sets the number of MAX7219 devices being used. Defaults to one.

On Entry:

Parameters

[in] num_devices - number of MAX7219 devices being used, must be >= 1.

On Exit:

Returns: returns number of devices, or 0xFF if error

uint8_t Max7219::write_digit	(	uint8_t	device_number,
		uint8_t	digit,
		uint8_t	data
	)

writes digit of given device with given data, user must enter correct data for decode_mode chosen

On Entry:

Parameters

[in]	device_number	- device to write too
[in]	digit	- digit to write
[in]	data	- data to write

On Exit:

Returns: returns 0 on success, returns 1 if device number is > _num_devices returns 2 if device number is 0 returns 3 if digit > 8 returns 4 if digit < 1 returns 0xFF if function just returns

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

C:/Users/Justin.Jordan/Documents/Arduino/libraries/MAX7219/src/max7219.h
C:/Users/Justin.Jordan/Documents/Arduino/libraries/MAX7219/src/max7219.cpp

Public Types

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation