skarg
350 lines
14 KiB
C
350 lines
14 KiB
C
/**************************************************************************
|
|
*
|
|
* Copyright (C) 2006 Steve Karg <skarg@users.sourceforge.net>
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included
|
|
* in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
*********************************************************************/
|
|
|
|
/* command line tool that sends a BACnet service, and displays the reply */
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <time.h> /* for time */
|
|
#include <string.h>
|
|
#include <errno.h>
|
|
#include "bactext.h"
|
|
#include "iam.h"
|
|
#include "arf.h"
|
|
#include "tsm.h"
|
|
#include "address.h"
|
|
#include "config.h"
|
|
#include "bacdef.h"
|
|
#include "npdu.h"
|
|
#include "apdu.h"
|
|
#include "device.h"
|
|
#include "net.h"
|
|
#include "datalink.h"
|
|
#include "whois.h"
|
|
/* some demo stuff needed */
|
|
#include "filename.h"
|
|
#include "handlers.h"
|
|
#include "client.h"
|
|
#include "txbuf.h"
|
|
|
|
/* buffer used for receive */
|
|
static uint8_t Rx_Buf[MAX_MPDU] = { 0 };
|
|
|
|
/* global variables used in this file */
|
|
static uint32_t Target_Device_Object_Instance = BACNET_MAX_INSTANCE;
|
|
static uint32_t Target_Object_Instance = BACNET_MAX_INSTANCE;
|
|
static BACNET_OBJECT_TYPE Target_Object_Type = OBJECT_ANALOG_INPUT;
|
|
static BACNET_PROPERTY_ID Target_Object_Property = PROP_ACKED_TRANSITIONS;
|
|
/* array index value or BACNET_ARRAY_ALL */
|
|
static int32_t Target_Object_Property_Index = BACNET_ARRAY_ALL;
|
|
static BACNET_APPLICATION_TAG Target_Object_Property_Tag =
|
|
BACNET_APPLICATION_TAG_NULL;
|
|
static BACNET_APPLICATION_DATA_VALUE Target_Object_Property_Value = { 0 };
|
|
|
|
/* 0 if not set, 1..16 if set */
|
|
static uint8_t Target_Object_Property_Priority = 0;
|
|
|
|
static BACNET_ADDRESS Target_Address;
|
|
static bool Error_Detected = false;
|
|
|
|
static void MyErrorHandler(BACNET_ADDRESS * src,
|
|
uint8_t invoke_id,
|
|
BACNET_ERROR_CLASS error_class, BACNET_ERROR_CODE error_code)
|
|
{
|
|
/* FIXME: verify src and invoke id */
|
|
(void) src;
|
|
(void) invoke_id;
|
|
printf("\r\nBACnet Error!\r\n");
|
|
printf("Error Class: %s\r\n", bactext_error_class_name(error_class));
|
|
printf("Error Code: %s\r\n", bactext_error_code_name(error_code));
|
|
Error_Detected = true;
|
|
}
|
|
|
|
void MyAbortHandler(BACNET_ADDRESS * src,
|
|
uint8_t invoke_id, uint8_t abort_reason, bool server)
|
|
{
|
|
/* FIXME: verify src and invoke id */
|
|
(void) src;
|
|
(void) invoke_id;
|
|
(void) server;
|
|
printf("\r\nBACnet Abort!\r\n");
|
|
printf("Abort Reason: %s\r\n",
|
|
bactext_abort_reason_name(abort_reason));
|
|
Error_Detected = true;
|
|
}
|
|
|
|
void MyRejectHandler(BACNET_ADDRESS * src,
|
|
uint8_t invoke_id, uint8_t reject_reason)
|
|
{
|
|
/* FIXME: verify src and invoke id */
|
|
(void) src;
|
|
(void) invoke_id;
|
|
printf("\r\nBACnet Reject!\r\n");
|
|
printf("Reject Reason: %s\r\n",
|
|
bactext_reject_reason_name(reject_reason));
|
|
Error_Detected = true;
|
|
}
|
|
|
|
void MyWritePropertySimpleAckHandler(BACNET_ADDRESS * src,
|
|
uint8_t invoke_id)
|
|
{
|
|
(void) src;
|
|
(void) invoke_id;
|
|
printf("\r\nWriteProperty Acknowledged!\r\n");
|
|
}
|
|
|
|
static void Init_Service_Handlers(void)
|
|
{
|
|
/* we need to handle who-is
|
|
to support dynamic device binding to us */
|
|
apdu_set_unconfirmed_handler(SERVICE_UNCONFIRMED_WHO_IS,
|
|
handler_who_is);
|
|
/* handle i-am to support binding to other devices */
|
|
apdu_set_unconfirmed_handler(SERVICE_UNCONFIRMED_I_AM,
|
|
handler_i_am_bind);
|
|
/* set the handler for all the services we don't implement
|
|
It is required to send the proper reject message... */
|
|
apdu_set_unrecognized_service_handler_handler
|
|
(handler_unrecognized_service);
|
|
/* we must implement read property - it's required! */
|
|
apdu_set_confirmed_handler(SERVICE_CONFIRMED_READ_PROPERTY,
|
|
handler_read_property);
|
|
/* handle the ack coming back */
|
|
apdu_set_confirmed_simple_ack_handler(SERVICE_CONFIRMED_WRITE_PROPERTY,
|
|
MyWritePropertySimpleAckHandler);
|
|
/* handle any errors coming back */
|
|
apdu_set_error_handler(SERVICE_CONFIRMED_WRITE_PROPERTY,
|
|
MyErrorHandler);
|
|
apdu_set_abort_handler(MyAbortHandler);
|
|
apdu_set_reject_handler(MyRejectHandler);
|
|
}
|
|
|
|
int main(int argc, char *argv[])
|
|
{
|
|
BACNET_ADDRESS src = { 0 }; /* address where message came from */
|
|
uint16_t pdu_len = 0;
|
|
unsigned timeout = 100; /* milliseconds */
|
|
unsigned max_apdu = 0;
|
|
time_t elapsed_seconds = 0;
|
|
time_t last_seconds = 0;
|
|
time_t current_seconds = 0;
|
|
time_t timeout_seconds = 0;
|
|
uint8_t invoke_id = 0;
|
|
bool found = false;
|
|
char *value_string = NULL;
|
|
bool status = false;
|
|
|
|
if (argc < 7) {
|
|
/* note: priority 16 and 0 should produce the same end results... */
|
|
printf("Usage: %s device-instance object-type object-instance "
|
|
"property tag value [priority] [index]\r\n",
|
|
filename_remove_path(argv[0]));
|
|
if ((argc > 1) && (strcmp(argv[1], "--help") == 0)) {
|
|
printf("device-instance:\r\n"
|
|
"BACnet Device Object Instance number that you are trying to\r\n"
|
|
"communicate to. This number will be used to try and bind with\r\n"
|
|
"the device using Who-Is and I-Am services. For example, if you were\r\n"
|
|
"writing to Device Object 123, the device-instance would be 123.\r\n"
|
|
"\r\n"
|
|
"object-type:\r\n"
|
|
"The object type is the integer value of the enumeration\r\n"
|
|
"BACNET_OBJECT_TYPE in bacenum.h. It is the object that you are\r\n"
|
|
"writing to. For example if you were writing to Analog Output 2, \r\n"
|
|
"the object-type would be 1.\r\n"
|
|
"\r\n"
|
|
"object-instance:\r\n"
|
|
"This is the object instance number of the object that you are \r\n"
|
|
"writing to. For example, if you were writing to Analog Output 2, \r\n"
|
|
"the object-instance would be 2.\r\n"
|
|
"\r\n"
|
|
"property:\r\n"
|
|
"The property is an integer value of the enumeration \r\n"
|
|
"BACNET_PROPERTY_ID in bacenum.h. It is the property you are \r\n"
|
|
"writing to. For example, if you were writing to the Present Value\r\n"
|
|
"property, you would use 85 as the property.\r\n"
|
|
"\r\n"
|
|
"tag:\r\n"
|
|
"Tag is the integer value of the enumeration BACNET_APPLICATION_TAG \r\n"
|
|
"in bacenum.h. It is the data type of the value that you are\r\n"
|
|
"writing. For example, if you were writing a REAL value, you would \r\n"
|
|
"use a tag of 4."
|
|
"\r\n"
|
|
"value:\r\n"
|
|
"The value is an ASCII representation of some type of data that you\r\n"
|
|
"are writing. It is encoded using the tag information provided. For\r\n"
|
|
"example, if you were writing a REAL value of 100.0, you would use \r\n"
|
|
"100.0 as the value.\r\n"
|
|
"\r\n"
|
|
"[priority]:\r\n"
|
|
"This optional parameter is used for setting the priority of the\r\n"
|
|
"write. If no priority is given, none is sent, and the BACnet \r\n"
|
|
"standard requires that the value is written at the lowest \r\n"
|
|
"priority (16) if the object property supports priorities.\r\n"
|
|
"\r\n"
|
|
"[index]\r\n"
|
|
"This optional integer parameter is the index number of an array.\r\n"
|
|
"If the property is an array, individual elements can be written\r\n"
|
|
"to if supported.\r\n"
|
|
"\r\n"
|
|
"Here is a brief overview of BACnet property and tags:\r\n"
|
|
"Certain properties are expected to be written with certain \r\n"
|
|
"application tags, so you probably need to know which ones to use\r\n"
|
|
"with each property of each object. It is almost safe to say that\r\n"
|
|
"given a property and an object and a table, the tag could be looked\r\n"
|
|
"up automatically. There may be a few exceptions to this, such as\r\n"
|
|
"the Any property type in the schedule object and the Present Value\r\n"
|
|
"accepting REAL, BOOLEAN, NULL, etc. Perhaps it would be simpler for\r\n"
|
|
"the demo to use this kind of table - but I also wanted to be able\r\n"
|
|
"to do negative testing by passing the wrong tag and have the server\r\n"
|
|
"return a reject message.\r\n"
|
|
"\r\n"
|
|
"Example:\r\n"
|
|
"If you want send a 100 to the Present-Value in the Analog Output\r\n"
|
|
"at priority 16, you could send the following command:\r\n"
|
|
"%s 123 1 0 85 4 100\r\n"
|
|
"You could also send a relinquish command:\r\n"
|
|
"%s 123 1 0 85 0 0\r\n",
|
|
filename_remove_path(argv[0]),
|
|
filename_remove_path(argv[0]));
|
|
}
|
|
return 0;
|
|
}
|
|
/* decode the command line parameters */
|
|
Target_Device_Object_Instance = strtol(argv[1], NULL, 0);
|
|
Target_Object_Type = strtol(argv[2], NULL, 0);
|
|
Target_Object_Instance = strtol(argv[3], NULL, 0);
|
|
Target_Object_Property = strtol(argv[4], NULL, 0);
|
|
Target_Object_Property_Tag = strtol(argv[5], NULL, 0);
|
|
value_string = argv[6];
|
|
/* optional priority */
|
|
if (argc > 7)
|
|
Target_Object_Property_Priority = strtol(argv[7], NULL, 0);
|
|
/* optional index */
|
|
if (argc > 8)
|
|
Target_Object_Property_Index = strtol(argv[8], NULL, 0);
|
|
|
|
if (Target_Device_Object_Instance > BACNET_MAX_INSTANCE) {
|
|
fprintf(stderr, "device-instance=%u - it must be less than %u\r\n",
|
|
Target_Device_Object_Instance, BACNET_MAX_INSTANCE + 1);
|
|
return 1;
|
|
}
|
|
if (Target_Object_Type > MAX_BACNET_OBJECT_TYPE) {
|
|
fprintf(stderr, "object-type=%u - it must be less than %u\r\n",
|
|
Target_Object_Type, MAX_BACNET_OBJECT_TYPE + 1);
|
|
return 1;
|
|
}
|
|
if (Target_Object_Instance > BACNET_MAX_INSTANCE) {
|
|
fprintf(stderr, "object-instance=%u - it must be less than %u\r\n",
|
|
Target_Object_Instance, BACNET_MAX_INSTANCE + 1);
|
|
return 1;
|
|
}
|
|
if (Target_Object_Property > MAX_BACNET_PROPERTY_ID) {
|
|
fprintf(stderr, "object-type=%u - it must be less than %u\r\n",
|
|
Target_Object_Property, MAX_BACNET_PROPERTY_ID + 1);
|
|
return 1;
|
|
}
|
|
if (Target_Object_Property_Tag >= MAX_BACNET_APPLICATION_TAG) {
|
|
fprintf(stderr, "tag=%u - it must be less than %u\r\n",
|
|
Target_Object_Property_Tag, MAX_BACNET_APPLICATION_TAG);
|
|
return 1;
|
|
}
|
|
status = bacapp_parse_application_data(Target_Object_Property_Tag,
|
|
value_string, &Target_Object_Property_Value);
|
|
if (!status) {
|
|
/* FIXME: show the expected entry format for the tag */
|
|
fprintf(stderr, "unable to parse the tag value\r\n");
|
|
return 1;
|
|
}
|
|
|
|
/* setup my info */
|
|
Device_Set_Object_Instance_Number(BACNET_MAX_INSTANCE);
|
|
address_init();
|
|
Init_Service_Handlers();
|
|
/* configure standard BACnet/IP port */
|
|
bip_set_interface("eth0"); /* for linux */
|
|
bip_set_port(0xBAC0);
|
|
if (!bip_init())
|
|
return 1;
|
|
/* configure the timeout values */
|
|
last_seconds = time(NULL);
|
|
timeout_seconds = (Device_APDU_Timeout() / 1000) *
|
|
Device_Number_Of_APDU_Retries();
|
|
/* try to bind with the device */
|
|
Send_WhoIs(Target_Device_Object_Instance,
|
|
Target_Device_Object_Instance);
|
|
/* loop forever */
|
|
for (;;) {
|
|
/* increment timer - exit if timed out */
|
|
current_seconds = time(NULL);
|
|
|
|
/* returns 0 bytes on timeout */
|
|
pdu_len = bip_receive(&src, &Rx_Buf[0], MAX_MPDU, timeout);
|
|
|
|
/* process */
|
|
if (pdu_len) {
|
|
npdu_handler(&src, &Rx_Buf[0], pdu_len);
|
|
}
|
|
/* at least one second has passed */
|
|
if (current_seconds != last_seconds)
|
|
tsm_timer_milliseconds(((current_seconds -
|
|
last_seconds) * 1000));
|
|
if (Error_Detected)
|
|
break;
|
|
/* wait until the device is bound, or timeout and quit */
|
|
found = address_bind_request(Target_Device_Object_Instance,
|
|
&max_apdu, &Target_Address);
|
|
if (found) {
|
|
if (invoke_id == 0) {
|
|
invoke_id =
|
|
Send_Write_Property_Request
|
|
(Target_Device_Object_Instance, Target_Object_Type,
|
|
Target_Object_Instance, Target_Object_Property,
|
|
&Target_Object_Property_Value,
|
|
Target_Object_Property_Priority,
|
|
Target_Object_Property_Index);
|
|
} else if (tsm_invoke_id_free(invoke_id))
|
|
break;
|
|
else if (tsm_invoke_id_failed(invoke_id)) {
|
|
fprintf(stderr, "\rError: TSM Timeout!\r\n");
|
|
tsm_free_invoke_id(invoke_id);
|
|
/* try again or abort? */
|
|
break;
|
|
}
|
|
} else {
|
|
/* increment timer - exit if timed out */
|
|
elapsed_seconds += (current_seconds - last_seconds);
|
|
if (elapsed_seconds > timeout_seconds) {
|
|
printf("\rError: APDU Timeout!\r\n");
|
|
break;
|
|
}
|
|
}
|
|
/* keep track of time for next check */
|
|
last_seconds = current_seconds;
|
|
}
|
|
|
|
return 0;
|
|
}
|