lsab_minimal_all.c File Reference

Example device implementing Function Block LSABExample code for Function Block LSAB. More...

#include "oc_api.h"
#include "oc_core_res.h"
#include "api/oc_knx_fp.h"
#include "port/oc_clock.h"
#include <signal.h>
#include "api/oc_knx_dev.h"
#include <stdio.h>
#include <unistd.h>

Go to the source code of this file.

Macros
#define	_WIN32_WINNT   0x8000
#define	btoa(x)   ((x) ? "true" : "false")
#define	GetCurrentDir   getcwd
#define	MY_NAME   "Actuator (LSAB) 417"
	The name of the application. More...
#define	STATIC   static

Functions
int	app_init (void)
	function to set up the device. More...
void	factory_presets_cb (size_t device, void *data)
	initiate preset for device current implementation: device reset as command line argument More...
STATIC void	get_o_1_1 (oc_request_t *request, oc_interface_mask_t interfaces, void *user_data)
	get method for "p/o_1_1" resource. More...
void	handle_signal (int signal)
	handle Ctrl-C More...
void	hostname_cb (size_t device_index, oc_string_t host_name, void *data)
	set the host name on the device (application depended) More...
void	initialize_variables (void)
	initializes the global variables registers and starts the handler More...
int	main (int argc, char *argv[])
	main application. More...
void	print_usage ()
	print usage and quits More...
STATIC void	put_o_1_1 (oc_request_t *request, oc_interface_mask_t interfaces, void *user_data)
	Put method for "p/o_1_1" resource. More...
void	register_resources (void)
	register all the resources to the stack this function registers all application level resources: More...
void	reset_cb (size_t device_index, int reset_value, void *data)
	application reset More...
void	restart_cb (size_t device_index, void *data)
	restart the device (application depended) More...
void	swu_cb (size_t device, oc_separate_response_t *response, size_t binary_size, size_t offset, uint8_t *payload, size_t len, void *data)
	software update callback More...

Variables
bool	g_mystate = false
	the state of the dpa 417.61 More...
bool	g_reset = false
	reset the device (from startup) More...
volatile int	quit = 0
	stop variable, used by handle_signal More...

Detailed Description

Example device implementing Function Block LSAB

Example code for Function Block LSAB.

Implements data point 61: switch on/off. This implementation is a actuator, e.g. receives data and acts on it.

Application Design

Support functions:

• app_init:
  • initializes the stack values.
• register_resources:
  • function that registers all endpoints,
  • sets the GET/PUT/POST/DELETE handlers for each end point

• main:

  • starts the stack, with the registered resources.
  • can be compiled out with NO_MAIN

  Handlers for the implemented methods (get/post):

  • get_[path] :
    • function that is being called when a GET is called on [path]
    • set the global variables in the output
  • post_[path] :
    • function that is being called when a POST is called on [path]
    • checks the input data
    • if input data is correct
      • updates the global variables

Defines

stack specific defines:

• linux build for Linux
• WIN32 build for windows
• OC_OSCORE oscore is enabled as compile flag

File specific defines:

• NO_MAIN compile out the function main()
• INCLUDE_EXTERNAL includes header file "external_header.h", so that other tools/dependencies can be included without changing this code

Definition in file lsab_minimal_all.c.

Macro Definition Documentation

MY_NAME

#define MY_NAME   "Actuator (LSAB) 417"

The name of the application.

Definition at line 100 of file lsab_minimal_all.c.

Function Documentation

app_init()

int app_init

(

void

)

function to set up the device.

sets the:

• serial number
• base path
• knx spec version
• hardware version
• firmware version
• hardware type
• device model

Definition at line 134 of file lsab_minimal_all.c.

{
  /* set the manufacturer name */
  int ret = oc_init_platform("Cascoda", NULL, NULL);
 
  /* set the application name, version, base url, device serial number */
  ret |= oc_add_device(MY_NAME, "1.0.0", "//", "00FA10010701", NULL, NULL);
 
  oc_device_info_t *device = oc_core_get_device_info(0);
  PRINT("Serial Number: %s\n", oc_string_checked(device->serialnumber));
 
  /* set the hardware version 1.0.0 */
  oc_core_set_device_hwv(0, 1, 0, 0);
 
  /* set the firmware version 1.0.0 */
  oc_core_set_device_fwv(0, 1, 0, 0);
 
  /* set the hardware type*/
  oc_core_set_device_hwt(0, "Pi");
 
  /* set the application info*/
  oc_core_set_device_ap(0, 1, 0, 0);
 
  /* set the manufacturer info*/
  oc_core_set_device_mid(0, 12);
 
  /* set the model */
  oc_core_set_device_model(0, "Cascoda Actuator");
 
#ifdef OC_SPAKE
#define PASSWORD "LETTUCE"
  oc_spake_set_password(PASSWORD);
  PRINT(" SPAKE password %s\n", PASSWORD);
#endif
 
  return ret;
}

References MY_NAME, oc_add_device(), oc_core_get_device_info(), and oc_init_platform().

factory_presets_cb()

void factory_presets_cb	(	size_t	device,
		void *	data
	)

initiate preset for device current implementation: device reset as command line argument

Parameters

device	the device identifier of the list of devices
data	the supplied data.

Definition at line 377 of file lsab_minimal_all.c.

{
  (void)device;
  (void)data;
 
  if (g_reset) {
    PRINT("factory_presets_cb: resetting device\n");
    oc_knx_device_storage_reset(0, 2);
  }
}

References g_reset.

get_o_1_1()

STATIC void get_o_1_1	(	oc_request_t *	request,
		oc_interface_mask_t	interfaces,
		void *	user_data
	)

get method for "p/o_1_1" resource.

function is called to initialize the return values of the GET method. initialization of the returned values are done from the global property values. Resource Description: This Resource describes a binary switch (on/off). The Property "value" is a boolean. A value of 'true' means that the switch is on. A value of 'false' means that the switch is off.

Parameters

request	the request representation.
interfaces	the interface used for this call
user_data	the user data.

Definition at line 185 of file lsab_minimal_all.c.

{
  (void)user_data; /* variable not used */
 
  /* TODO: SENSOR add here the code to talk to the HW if one implements a
     sensor. the call to the HW needs to fill in the global variable before it
     returns to this function here. alternative is to have a callback from the
     hardware that sets the global variables.
  */
  bool error_state = false; /* the error state, the generated code */
  int oc_status_code = OC_STATUS_OK;
 
  PRINT("-- Begin get_dpa_417_61: interface %d\n", interfaces);
  /* check if the accept header is CBOR */
  if (oc_check_accept_header(request, APPLICATION_CBOR) == false) {
    oc_send_response_no_format(request, OC_STATUS_BAD_OPTION);
    return;
  }
 
  // check the query parameter m with the various values
  char *m;
  char *m_key;
  size_t m_key_len;
  size_t m_len = (int)oc_get_query_value(request, "m", &m);
  if (m_len != -1) {
    PRINT("  Query param: %.*s", (int)m_len, m);
    oc_init_query_iterator();
    size_t device_index = request->resource->device;
    oc_device_info_t *device = oc_core_get_device_info(device_index);
    if (device != NULL) {
      oc_rep_begin_root_object();
      while (oc_iterate_query(request, &m_key, &m_key_len, &m, &m_len) != -1) {
        // unique identifier
        if ((strncmp(m, "id", m_len) == 0) | (strncmp(m, "*", m_len) == 0)) {
          char mystring[100];
          snprintf(mystring, 99, "urn:knx:sn:%s%s",
                   oc_string(device->serialnumber),
                   oc_string(request->resource->uri));
          oc_rep_i_set_text_string(root, 0, mystring);
        }
        // resource types
        if ((strncmp(m, "rt", m_len) == 0) | (strncmp(m, "*", m_len) == 0)) {
          oc_rep_set_text_string(root, rt, "urn:knx:dpa.417.61");
        }
        // interfaces
        if ((strncmp(m, "if", m_len) == 0) | (strncmp(m, "*", m_len) == 0)) {
          oc_rep_set_text_string(root, if, "if.s");
        }
        if ((strncmp(m, "dpt", m_len) == 0) | (strncmp(m, "*", m_len) == 0)) {
          oc_rep_set_text_string(root, dpt, oc_string(request->resource->dpt));
        }
        // ga
        if ((strncmp(m, "ga", m_len) == 0) | (strncmp(m, "*", m_len) == 0)) {
          int index = oc_core_find_group_object_table_url(
            oc_string(request->resource->uri));
          if (index > -1) {
            oc_group_object_table_t *got_table_entry =
              oc_core_get_group_object_table_entry(index);
            if (got_table_entry) {
              oc_rep_set_int_array(root, ga, got_table_entry->ga,
                                   got_table_entry->ga_len);
            }
          }
        }
      } /* query iterator */
      oc_rep_end_root_object();
    } else {
      /* device is NULL */
      oc_send_response_no_format(request, OC_STATUS_BAD_OPTION);
    }
    oc_send_cbor_response(request, OC_STATUS_OK);
    return;
  }
 
  CborError error;
  oc_rep_begin_root_object();
  oc_rep_i_set_boolean(root, 1, g_mystate);
  oc_rep_end_root_object();
  error = g_err;
 
  if (error) {
    oc_status_code = true;
  }
  PRINT("CBOR encoder size %d\n", oc_rep_get_encoded_payload_size());
 
  if (error_state == false) {
    oc_send_cbor_response(request, oc_status_code);
  } else {
    oc_send_response_no_format(request, OC_STATUS_BAD_OPTION);
  }
  PRINT("-- End get_dpa_417_61\n");
}

References oc_status_code(), and OC_STATUS_OK.

handle_signal()

void handle_signal

(

int

signal

)

handle Ctrl-C

Parameters

signal

the captured signal

Definition at line 522 of file lsab_minimal_all.c.

{
  (void)signal;
  signal_event_loop();
  quit = 1;
}

References quit.

Referenced by main().

hostname_cb()

void hostname_cb	(	size_t	device_index,
		oc_string_t	host_name,
		void *	data
	)

set the host name on the device (application depended)

Parameters

device_index	the device identifier of the list of devices
host_name	the host name to be set on the device
data	the supplied data.

Definition at line 428 of file lsab_minimal_all.c.

{
  (void)device_index;
  (void)data;
 
  PRINT("-----host name ------- %s\n", oc_string_checked(host_name));
}

initialize_variables()

void initialize_variables

(

void

)

initializes the global variables registers and starts the handler

Definition at line 485 of file lsab_minimal_all.c.

{
  /* initialize global variables for resources */
}

main()

int main	(	int	argc,
		char *	argv[]
	)

main application.

initializes the global variables registers and starts the handler handles (in a loop) the next event. shuts down the stack

Definition at line 551 of file lsab_minimal_all.c.

{
  int init;
  oc_clock_time_t next_event;
  char *fname = "my_software_image";
 
#ifdef WIN32
  /* windows specific */
  InitializeCriticalSection(&cs);
  InitializeConditionVariable(&cv);
  /* install Ctrl-C */
  signal(SIGINT, handle_signal);
#endif
#ifdef __linux__
  /* Linux specific */
  struct sigaction sa;
  sigfillset(&sa.sa_mask);
  sa.sa_flags = 0;
  sa.sa_handler = handle_signal;
  /* install Ctrl-C */
  sigaction(SIGINT, &sa, NULL);
#endif
 
  for (int i = 0; i < argc; i++) {
    PRINT("argv[%d] = %s\n", i, argv[i]);
  }
  if (argc > 1) {
    if (strcmp(argv[1], "reset") == 0) {
      PRINT(" internal reset\n");
      g_reset = true;
    }
    if (strcmp(argv[1], "-help") == 0) {
      print_usage();
    }
  }
 
  PRINT("KNX-IOT Server name : \"%s\"\n", MY_NAME);
 
  char buff[FILENAME_MAX];
  char *retbuf = NULL;
  retbuf = GetCurrentDir(buff, FILENAME_MAX);
  if (retbuf != NULL) {
    PRINT("Current working dir: %s\n", buff);
  }
 
  /*
   The storage folder depends on the build system
   the folder is created in the makefile, with $target as name with _cred as
   post fix.
  */
  PRINT("\tstorage at './LSAB_minimal_creds' \n");
  oc_storage_config("./LSAB_minimal_creds");
 
  /*initialize the variables */
  initialize_variables();
 
  /* initializes the handlers structure */
  STATIC const oc_handler_t handler = { .init = app_init,
                                        .signal_event_loop = signal_event_loop,
                                        .register_resources = register_resources
#ifdef OC_CLIENT
                                        ,
                                        .requests_entry = 0
#endif
  };
 
  /* set the application callbacks */
  oc_set_hostname_cb(hostname_cb, NULL);
  oc_set_reset_cb(reset_cb, NULL);
  oc_set_restart_cb(restart_cb, NULL);
  oc_set_factory_presets_cb(factory_presets_cb, NULL);
  oc_set_swu_cb(swu_cb, (void *)fname);
 
  /* start the stack */
  init = oc_main_init(&handler);
 
  if (init < 0) {
    PRINT("oc_main_init failed %d, exiting.\n", init);
    return init;
  }
#ifdef OC_OSCORE
  PRINT("OSCORE - Enabled\n");
#else
  PRINT("OSCORE - Disabled\n");
#endif /* OC_OSCORE */
 
  oc_device_info_t *device = oc_core_get_device_info(0);
  PRINT("serial number: %s\n", oc_string_checked(device->serialnumber));
 
  oc_endpoint_t *my_ep = oc_connectivity_get_endpoints(0);
  if (my_ep != NULL) {
    PRINTipaddr(*my_ep);
    PRINT("\n");
  }
  PRINT("Server \"%s\" running, waiting on incoming "
        "connections.\n",
        MY_NAME);
 
#ifdef WIN32
  /* windows specific loop */
  while (quit != 1) {
    next_event = oc_main_poll();
    if (next_event == 0) {
      SleepConditionVariableCS(&cv, &cs, INFINITE);
    } else {
      oc_clock_time_t now = oc_clock_time();
      if (now < next_event) {
        SleepConditionVariableCS(
          &cv, &cs, (DWORD)((next_event - now) * 1000 / OC_CLOCK_SECOND));
      }
    }
  }
#endif
 
#ifdef __linux__
  /* Linux specific loop */
  while (quit != 1) {
    next_event = oc_main_poll();
    pthread_mutex_lock(&mutex);
    if (next_event == 0) {
      pthread_cond_wait(&cv, &mutex);
    } else {
      ts.tv_sec = (next_event / OC_CLOCK_SECOND);
      ts.tv_nsec = (next_event % OC_CLOCK_SECOND) * 1.e09 / OC_CLOCK_SECOND;
      pthread_cond_timedwait(&cv, &mutex, &ts);
    }
    pthread_mutex_unlock(&mutex);
  }
#endif
 
  /* shut down the stack */
 
  oc_main_shutdown();
  return 0;
}

References handle_signal().

print_usage()

void print_usage

(

)

print usage and quits

Definition at line 534 of file lsab_minimal_all.c.

{
  PRINT("Usage:\n");
  PRINT("no arguments : starts the server\n");
  PRINT("-help  : this message\n");
  PRINT("reset : does an full reset of the device\n");
  exit(0);
}

put_o_1_1()

STATIC void put_o_1_1	(	oc_request_t *	request,
		oc_interface_mask_t	interfaces,
		void *	user_data
	)

Put method for "p/o_1_1" resource.

The function has as input the request body, which are the input values of the PUT method. The input values (as a set) are checked if all supplied values are correct. If the input values are correct, they will be assigned to the global property values. Resource Description:

Parameters

request	the request representation.
interfaces	the used interfaces during the request.
user_data	the supplied user data.

Definition at line 292 of file lsab_minimal_all.c.

{
  (void)interfaces;
  (void)user_data;
  bool error_state = false;
  PRINT("-- Begin put_dpa_417_61:\n");
 
  oc_rep_t *rep = NULL;
  // handle the different requests
  if (oc_is_redirected_request(request)) {
    PRINT(" S-MODE or /P\n");
  }
  rep = request->request_payload;
  while (rep != NULL) {
    if (rep->type == OC_REP_BOOL) {
      if (rep->iname == 1) {
        PRINT("  put_dpa_417_61 received : %d\n", rep->value.boolean);
        g_mystate = rep->value.boolean;
        oc_send_cbor_response(request, OC_STATUS_CHANGED);
        PRINT("-- End put_dpa_417_61\n");
        return;
      }
    }
    rep = rep->next;
  }
 
  oc_send_response_no_format(request, OC_STATUS_BAD_REQUEST);
  PRINT("-- End put_dpa_417_61\n");
}

register_resources()

void register_resources

(

void

)

register all the resources to the stack this function registers all application level resources:

• each resource path is bind to a specific function for the supported methods (GET, POST, PUT, DELETE)
• each resource is:
  • secure
  • observable
  • discoverable
  • used interfaces

URL Table

resource url	functional block/dpa	GET	PUT
p/o_1_1	urn:knx:dpa.417.61	Yes	Yes

Definition at line 340 of file lsab_minimal_all.c.

{
  PRINT("Register Resource with local path \"/p/o_1_1\"\n");
  PRINT("Light Switching actuator 417 (LSAB) : SwitchOnOff \n");
  PRINT("Data point 417.61 (DPT_Switch) \n");
  oc_resource_t *res_light =
    oc_new_resource("light actuation", "/p/o_1_1", 2, 0);
  oc_resource_bind_resource_type(res_light, "urn:knx:dpa.417.61");
  oc_resource_bind_dpt(res_light, "urn:knx:dpt.Switch");
  oc_resource_bind_content_type(res_light, APPLICATION_CBOR);
  oc_resource_bind_resource_interface(res_light, OC_IF_A); /* if.a */
  oc_resource_set_discoverable(res_light, true);
  /* periodic observable
     to be used when one wants to send an event per time slice
     period is 1 second */
  oc_resource_set_periodic_observable(res_light, 1);
  /* set observable
     events are send when oc_notify_observers(oc_resource_t *resource) is
    called. this function must be called when the value changes, preferable on
    an interrupt when something is read from the hardware. */
  // oc_resource_set_observable(res_352, true);
  // set the GET handler
  oc_resource_set_request_handler(res_light, OC_GET, get_o_1_1, NULL);
  // set the PUT handler
  oc_resource_set_request_handler(res_light, OC_PUT, put_o_1_1, NULL);
  // register this resource,
  // this means that the resource will be listed in /.well-known/core
  oc_add_resource(res_light);
}

reset_cb()

void reset_cb	(	size_t	device_index,
		int	reset_value,
		void *	data
	)

application reset

Parameters

device_index	the device identifier of the list of devices
reset_value	the knx reset value
data	the supplied data.

Definition at line 396 of file lsab_minimal_all.c.

{
  (void)device_index;
  (void)data;
 
  PRINT("reset_cb %d\n", reset_value);
}

restart_cb()

void restart_cb	(	size_t	device_index,
		void *	data
	)

restart the device (application depended)

Parameters

device_index	the device identifier of the list of devices
data	the supplied data.

Definition at line 411 of file lsab_minimal_all.c.

{
  (void)device_index;
  (void)data;
 
  PRINT("-----restart_cb -------\n");
  // exit(0);
}

swu_cb()

void swu_cb	(	size_t	device,
		oc_separate_response_t *	response,
		size_t	binary_size,
		size_t	offset,
		uint8_t *	payload,
		size_t	len,
		void *	data
	)

software update callback

Parameters

device	the device index
response	the instance of an internal struct that is used to track the state of the separate response
binary_size	the full size of the binary
offset	the offset of the image
payload	the image data
len	the length of the image data
data	the user data

Definition at line 465 of file lsab_minimal_all.c.

{
  (void)device;
  (void)binary_size;
  char filename[] = "./downloaded.bin";
  PRINT(" swu_cb %s block=%d size=%d \n", filename, (int)offset, (int)len);
 
  FILE *write_ptr = fopen("downloaded_bin", "ab");
  size_t r = fwrite(payload, sizeof(*payload), len, write_ptr);
  fclose(write_ptr);
 
  oc_set_delayed_callback(response, &send_delayed_response, 0);
}

Variable Documentation

g_mystate

bool g_mystate = false

the state of the dpa 417.61

Definition at line 116 of file lsab_minimal_all.c.

g_reset

bool g_reset = false

reset the device (from startup)

Definition at line 118 of file lsab_minimal_all.c.

Referenced by factory_presets_cb().

quit

volatile int quit = 0

stop variable, used by handle_signal

Definition at line 117 of file lsab_minimal_all.c.

Referenced by handle_signal().