Logo
UNICENS V2.3.0-4567
User Manual and API Reference
Ucs_Return_t Ucs_Gpio_CreatePort ( Ucs_Inst_t self,
uint16_t  node_address,
uint8_t  index,
uint16_t  debounce_time,
Ucs_Gpio_CreatePortResCb_t  result_fptr 
)

Creates the GPIO port with its associated port instance identifier.

 This function corresponds with the INIC function INIC.GPIOPortCreate.
Parameters
selfThe UNICENS instance pointer
node_addressAddress of the target device. Use the UCS_ADDR_LOCAL_NODE macro to target the local device.
The following address ranges are supported:
  • [0x10 ... 0x2FF]
  • [0x500 ... 0xFEF]
  • UCS_ADDR_LOCAL_NODE
indexThe index of the GPIO Port instance.
 Index
debounce_timeThe timeout for the GPIO debounce timer (in ms).
 DebounceTime
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 is available.
UCS_RET_ERR_API_LOCKED API is currently locked.
UCS_RET_ERR_NOT_SUPPORTED API is not supported in the current Network Supervisor Mode.
UCS_RET_ERR_NOT_INITIALIZED UNICENS is not initialized.
 See also section Example for Ucs_Gpio_CreatePort for an example implementation.