KNX IoT
KNX IoT Point API stack implementation
oc_group_rp_table_t Struct Reference

Function point Recipient - Publisher Table Resource (/fp/r) (/fp/p) More...

#include <oc_knx_fp.h>

Data Fields

oc_string_t at
 Access token id. More...
 
int64_t fid
 contents of fabric id More...
 
uint32_t * ga
 array of integers More...
 
int ga_len
 length of the array of group addresses identifiers More...
 
uint32_t grpid
 the multicast group id More...
 
int ia
 contents of ia (individual address) More...
 
int id
 contents of id More...
 
int64_t iid
 contents of installation id More...
 
int mt
 The number of maximum retransmissions for CON & NON requests. More...
 
bool non
 true = non-confirmable unicast request, default = false More...
 
oc_string_t path
 contents of path, default path = ".knx" More...
 
oc_string_t url
 contents of url More...
 

Detailed Description

Function point Recipient - Publisher Table Resource (/fp/r) (/fp/p)

the same table is used for recipient and publisher. the only difference is the confirmable/not confirmable flag. There will be 2 arrays of the structure to store the /fp/r or /fp/p data

Example (JSON): array of objects

[
{
"id": "1",
"ia": 5,
"ga":[2305, 2401],
"path": "k",
},
{
"id": "2",
"url": "coap://<IP multicast, unicast address or fqdn>/<path>",
"ga": [2305, 2306, 2307, 2308]
}
]

Key translation

Json Key Integer Value
id 0
ia 12
iid 26
fid 25
grpid 13
path 112
url 10
ga 7
non -

The structure stores the information. The structure will be used as an array. There are function to find:

  • max amount of entries
  • empty index in the array
  • find the index with a specific id
  • delete an index, e.g. delete the array entry of data
  • make the entry persistent
  • free up the allocated data
  • return the structure at a specific index

Definition at line 175 of file oc_knx_fp.h.

Field Documentation

◆ at

oc_string_t at

Access token id.

Reference to the security credentials for unicast subscription encryption.

Definition at line 184 of file oc_knx_fp.h.

◆ fid

int64_t fid

contents of fabric id

Definition at line 180 of file oc_knx_fp.h.

◆ ga

uint32_t* ga

array of integers

Definition at line 186 of file oc_knx_fp.h.

◆ ga_len

int ga_len

length of the array of group addresses identifiers

Definition at line 187 of file oc_knx_fp.h.

◆ grpid

uint32_t grpid

the multicast group id

Definition at line 181 of file oc_knx_fp.h.

◆ ia

int ia

contents of ia (individual address)

Definition at line 178 of file oc_knx_fp.h.

◆ id

int id

contents of id

Definition at line 177 of file oc_knx_fp.h.

◆ iid

int64_t iid

contents of installation id

Definition at line 179 of file oc_knx_fp.h.

◆ mt

int mt

The number of maximum retransmissions for CON & NON requests.

Definition at line 189 of file oc_knx_fp.h.

◆ non

bool non

true = non-confirmable unicast request, default = false

Definition at line 188 of file oc_knx_fp.h.

◆ path

oc_string_t path

contents of path, default path = ".knx"

Definition at line 182 of file oc_knx_fp.h.

◆ url

oc_string_t url

contents of url

Definition at line 183 of file oc_knx_fp.h.


The documentation for this struct was generated from the following file: