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. More...
	GPIOWiced ()
	GPIO WICED default constructor. More...
	~GPIOWiced ()
	GPIO WICED destructor. More...
HallSwitch::Error_t	init ()
	Initializes the WICED GPIO. More...
HallSwitch::Error_t	deinit ()
	Initializes the WICED GPIO. More...
HallSwitch::Error_t	enableInt (HallSwitch *ptr)
	Enables the WICED GPIO interrupt. More...
HallSwitch::Error_t	disableInt ()
	Disables the WICED GPIO interrupt. More...
IntEvent_t	intEvent ()
	Gets the latest WICED interrupt event. More...
VLevel_t	read ()
	Reads the WICED GPIO voltage level. More...
HallSwitch::Error_t	write (VLevel_t level)
	Writes the WICED GPIO output voltage level. More...
HallSwitch::Error_t	enable ()
	Enables the WICED output according to the GPIO logic. More...
HallSwitch::Error_t	disable ()
	Disables the WICED output according to the GPIO logic. More...

Additional Inherited Members
Public Types inherited from HallSwitch::GPIO
enum	IntEvent_t { INT_FALLING_EDGE = 0, INT_RISING_EDGE = 1 }
enum	VLevel_t { GPIO_LOW = 0, GPIO_HIGH = 1 }
enum	VLogic_t { NEGATIVE = 1, POSITIVE = 2 }

Constructor & Destructor Documentation

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

GPIO WICED default constructor.

GPIOWiced::GPIOWiced

(

)

GPIO WICED default constructor.

GPIOWiced::~GPIOWiced

(

)

GPIO WICED destructor.

Here is the call graph for this function:

Member Function Documentation

HallSwitch::Error_t GPIOWiced::init ( )

inlinevirtual

Initializes the WICED GPIO.

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if initialization error

Implements HallSwitch::GPIO.

HallSwitch::Error_t GPIOWiced::deinit ( )

inlinevirtual

Initializes the WICED GPIO.

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if deinitialization error

Implements HallSwitch::GPIO.

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

inlinevirtual

Enables the WICED GPIO interrupt.

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if error

Implements HallSwitch::GPIO.

Here is the call graph for this function:

HallSwitch::Error_t GPIOWiced::disableInt ( )

inlinevirtual

Disables the WICED GPIO interrupt.

Returns

GPIO error code

Return values

OK	if success
INTF_ERROR	if error

Implements HallSwitch::GPIO.

GPIOWiced::IntEvent_t GPIOWiced::intEvent ( )

inlinevirtual

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

Implements HallSwitch::GPIO.

GPIOWiced::VLevel_t GPIOWiced::read ( )

inlinevirtual

Reads the WICED GPIO voltage level.

Returns

GPIO voltage level

Return values

GPIO_LOW	if voltage low
GPIO_HIGH	if voltage high

Implements HallSwitch::GPIO.

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

inlinevirtual

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

Implements HallSwitch::GPIO.

HallSwitch::Error_t GPIOWiced::enable ( )

inlinevirtual

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

Implements HallSwitch::GPIO.

HallSwitch::Error_t GPIOWiced::disable ( )

inlinevirtual

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

Implements HallSwitch::GPIO.

---

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

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