From ec59d20bafb3acaaff2bbcab185a074825319e20 Mon Sep 17 00:00:00 2001 From: Ronan Le Martret Date: Mon, 12 Jun 2017 11:17:04 +0200 Subject: Update package * use sub module for ucs2-lib (tmp fork from IoT.bzh github) * add packaging for native build Signed-off-by: Ronan Le Martret --- ...g_p_i_o_gaa2dc67622555e9e64e4bb524a8e18642.html | 213 --------------------- 1 file changed, 213 deletions(-) delete mode 100644 ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o_gaa2dc67622555e9e64e4bb524a8e18642.html (limited to 'ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o_gaa2dc67622555e9e64e4bb524a8e18642.html') diff --git a/ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o_gaa2dc67622555e9e64e4bb524a8e18642.html b/ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o_gaa2dc67622555e9e64e4bb524a8e18642.html deleted file mode 100644 index abc8fbf..0000000 --- a/ucs2-lib/doc/html/group___g___u_c_s___g_p_i_o_gaa2dc67622555e9e64e4bb524a8e18642.html +++ /dev/null @@ -1,213 +0,0 @@ - - - - - -UNICENS: Ucs_Gpio_ReadPort - - - - - - - - - - - - - - - -
-
-
- - - - - - - -
Logo -
UNICENS V2.1.0-3491
-
User Manual and API Reference
- -
-
- - - -
-
- -
-
-
- -
- - - - -
- -
- -
- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Ucs_Return_t Ucs_Gpio_ReadPort (Ucs_Inst_tself,
uint16_t destination_address,
uint16_t gpio_port_handle,
Ucs_Gpio_PinStateResCb_t result_fptr 
)
-
- -

Reads the pin state of the given GPIO port.

- - - -
 This function corresponds with the INIC function INIC.GPIOPortPinState.
-
Parameters
- - - - - -
selfThe UNICENS instance pointer
destination_addressAddress of the target device. Use the UCS_ADDR_LOCAL_DEV macro to target the local device.
- The following address ranges are supported:
    -
  • [0x10 ... 0x2FF]
  • -
  • [0x500 ... 0xFEF]
  • -
  • UCS_ADDR_LOCAL_DEV
  • -
-
gpio_port_handleThe GPIO Port resource handle. - - -
 GPIOPortHandle
-
result_fptrRequired result callback function pointer.
-
-
-
Returns
Possible return values are shown in the table below. - - - - - - - - - - - - -
Value Description
UCS_RET_SUCCESS No error
UCS_RET_ERR_PARAM At least one parameter is wrong
UCS_RET_ERR_BUFFER_OVERFLOW No message buffer available
UCS_RET_ERR_API_LOCKED API is currently locked
UCS_RET_ERR_NOT_INITIALIZED UNICENS is not initialized
-
-


- Example

-
// Main function
-
void main()
-
{
-
Ucs_Return_t result = Ucs_Gpio_ReadPort(UCS_ADDR_LOCAL_DEV, 0x1D00, &App_GpioReadPortResCb);
-
if (result != UCS_RET_SUCCESS)
-
{
-
// Error handling here
-
}
-
}
-
-
// The event handler function
-
// Handle GpioReadPort event
-
static void App_GpioReadPortResCb(uint16_t device_id, uint16_t port_handle, uint16_t current_state, uint16_t sticky_state, Ucs_Gpio_Result_t result)
-
{
-
if (result.code == UCS_GPIO_RES_SUCCESS)
-
{
-
// Do what needs to be..
-
}
-
else
-
{
-
// Error handling here
-
}
-
}
-
-
-
-
-
- - - - - - -- cgit 1.2.3-korg