GPIOWiced Class Reference

#include <hall-pal-wiced.hpp>

Inheritance diagram for GPIOWiced:

Collaboration diagram for GPIOWiced:

Public Member Functions
	GPIOWiced (wiced_gpio_t pin, wiced_gpio_config_t config, VLogic_t logic)
	GPIO WICED default constructor.
	GPIOWiced ()
	GPIO WICED default constructor.
	~GPIOWiced ()
	GPIO WICED destructor.
HallSwitch::Error_t	init ()
	Initializes the WICED GPIO.
HallSwitch::Error_t	deinit ()
	Initializes the WICED GPIO.
HallSwitch::Error_t	enableInt (HallSwitch *ptr)
	Enables the WICED GPIO interrupt.
HallSwitch::Error_t	disableInt ()
	Disables the WICED GPIO interrupt.
IntEvent_t	intEvent ()
	Gets the latest WICED interrupt event.
VLevel_t	read ()
	Reads the WICED GPIO voltage level.
HallSwitch::Error_t	write (VLevel_t level)
	Writes the WICED GPIO output voltage level.
HallSwitch::Error_t	enable ()
	Enables the WICED output according to the GPIO logic.
HallSwitch::Error_t	disable ()
	Disables the WICED output according to the GPIO logic.

Constructor & Destructor Documentation

GPIOWiced() [1/2]

GPIOWiced::GPIOWiced	(	wiced_gpio_t	pin,
		wiced_gpio_config_t	config,
		VLogic_t	logic
	)

GPIO WICED default constructor.

GPIOWiced() [2/2]

GPIOWiced::GPIOWiced

(

)

GPIO WICED default constructor.

~GPIOWiced()

GPIOWiced::~GPIOWiced

(

)

GPIO WICED destructor.

Here is the call graph for this function:

Member Function Documentation

init()

HallSwitch::Error_t GPIOWiced::init ( )

inline

Initializes the WICED GPIO.

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if initialization error

deinit()

HallSwitch::Error_t GPIOWiced::deinit ( )

inline

Initializes the WICED GPIO.

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if deinitialization error

enableInt()

HallSwitch::Error_t GPIOWiced::enableInt ( HallSwitch *  ptr )

inline

Enables the WICED GPIO interrupt.

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if error

Here is the call graph for this function:

disableInt()

HallSwitch::Error_t GPIOWiced::disableInt ( )

inline

Disables the WICED GPIO interrupt.

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if error

intEvent()

GPIOWiced::IntEvent_t GPIOWiced::intEvent ( )

inline

Gets the latest WICED interrupt event.

Returns

GPIO interrupt event

Return values

INT_FALLING_EDGE	if falling edge event
INT_RISING_EDGE	if rising edge event

read()

GPIOWiced::VLevel_t GPIOWiced::read ( )

inline

Reads the WICED GPIO voltage level.

Returns

GPIO voltage level

Return values

GPIO_LOW	if voltage low
GPIO_HIGH	if voltage high

write()

HallSwitch::Error_t GPIOWiced::write ( VLevel_t  level )

inline

Writes the WICED GPIO output voltage level.

Parameters

[in]

level

Voltage level

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if error

enable()

HallSwitch::Error_t GPIOWiced::enable ( )

inline

Enables the WICED output according to the GPIO logic.

• Low if negative
• High if positive

  Returns

  GPIO interrupt event

  Return values

  OK	if success
  INTF_ERROR	if error

disable()

HallSwitch::Error_t GPIOWiced::disable ( )

inline

Disables the WICED output according to the GPIO logic.

• Low if positive
• High if negative

  Returns

  GPIO error code

  Return values

  OK	if success
  INTF_ERROR	if error

---

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

• hall-pal-wiced.hpp
• hall-pal-wiced.cpp