Kari Argillander
cb243c36a8
* Change MIT license texts to SPDX-License-Identifier SPDX-License-Identifier is much easier to understand and grep than license text so use that instead. * Change GPL exception license texts to SPDX-License-Identifier SPDX-License-Identifier is much easier to understand and grep than license text so use that instead. * Change misc license texts to SPDX-License-Identifier There are some external code in repo which are not licenses as most of the stuff in this repo. We still want every file to have SPDX identifier to easily grep licenses. * Add currently used license files Even though Bacnet-Stack is using SPDX identifiers we still need to give those license files with source. For this reason add all license files to license/ folder. SPDX has also files which would make same thing but this is style which example Linux kernel is using and it is quite clear so I choose that one for now. I choosed not yet bring CC-PDDC as that is not right license for those files. --------- Co-authored-by: Kari Argillander <kari.argillander@fidelix.com>
133 lines
3.1 KiB
Plaintext
133 lines
3.1 KiB
Plaintext
-----------------------
|
|
1. About
|
|
-----------------------
|
|
|
|
The Router connects two or more BACnet/IP and BACnet MS/TP networks.
|
|
Number of netwoks is limited only by available hardware communication devices (or ports for Ethernet).
|
|
|
|
-----------------------
|
|
2. License
|
|
-----------------------
|
|
|
|
Copyright (C) 2012 Andriy Sukhynyuk, Vasyl Tkhir, Andriy Ivasiv
|
|
|
|
SPDX-License-Identifier: MIT
|
|
|
|
-----------------------
|
|
3. Build
|
|
-----------------------
|
|
|
|
1. Download, build and install libconfig C/C++ Configuration File Library
|
|
from http://www.hyperrealm.com/libconfig or use APT to install
|
|
sudo apt-get install libconfig-dev
|
|
2. Run "make clean all" from library root directory
|
|
3. Run "make router" from library root directory
|
|
|
|
-----------------------
|
|
4. Router configuration
|
|
-----------------------
|
|
|
|
4.1. Configuration file format.
|
|
|
|
//single line comment
|
|
|
|
/*
|
|
multiline comment
|
|
*/
|
|
|
|
ports =
|
|
(
|
|
//route_1
|
|
{
|
|
device_type = "<value>";
|
|
//route specific arguments, see below
|
|
},
|
|
|
|
//route_2
|
|
{
|
|
device_type = "<value>";
|
|
//route specific arguments, see below
|
|
},
|
|
|
|
//.....
|
|
|
|
//route_n
|
|
{
|
|
device_type = "<value>";
|
|
//route specific arguments, see below
|
|
}
|
|
);
|
|
|
|
Note: - arguments are separeted with ';'
|
|
- routes are separeted with ','
|
|
- no ',' after the last route
|
|
|
|
4.2. Configuration file arguments.
|
|
|
|
Common arguments:
|
|
device_type - Describes a type of route, may be "bip" (Etherent) or "mstp" (Serial port). Use quotes.
|
|
device - Connection device, for example "eth0" or "/dev/ttyS0"; default values: for BIP:"eth0", for MSTP: "/dev/ttyS0". Use quotes.
|
|
network - Network number [1..65534]. Do not use network number 65535, it is broadcast number; default begins from 1 to routes count.
|
|
|
|
bip arguments:
|
|
port - bip UDP port; default port is 47808 (0xBAC0).
|
|
|
|
mstp arguments:
|
|
mac - MSTP MAC; default value is 127.
|
|
max_master - MSTP max master; default value is 127.
|
|
max_frames - 1. Segmentation does not supported.
|
|
baud - one from the list: 0, 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400; default baud is 9600
|
|
parity - one from the list (with quotes): "None", "Even", "Odd"; default parity "None". Use quotes.
|
|
databits - one from the list: 5, 6, 7, 8; default 8.
|
|
stopbits - 1 or 2; default 1.
|
|
|
|
4.3. Example of configuration file.
|
|
|
|
ports =
|
|
(
|
|
{
|
|
device_type = "bip";
|
|
device = "eth0";
|
|
port = 47808;
|
|
network = 1;
|
|
},
|
|
{
|
|
device_type = "bip";
|
|
device = "eth1";
|
|
port = 47808;
|
|
network = 2;
|
|
},
|
|
{
|
|
device_type = "bip";
|
|
device = "eth1";
|
|
port = 47809;
|
|
network = 3;
|
|
},
|
|
{
|
|
device_type = "mstp";
|
|
device = "/dev/ttyS0";
|
|
mac = 1;
|
|
max_master = 127;
|
|
max_frames = 1;
|
|
baud = 38400;
|
|
parity = "None";
|
|
databits = 8;
|
|
stopbits = 1;
|
|
network = 4;
|
|
}
|
|
);
|
|
|
|
-----------------------
|
|
5. Start
|
|
-----------------------
|
|
|
|
5.1. With configuration file
|
|
1. Copy configuration file in the router executable directory
|
|
2. Start the router with "sudo ./router -c init.cfg" command in terminal
|
|
|
|
5.2. Passing params in command line
|
|
1. sudo ./router -D "mstp" "/dev/ttyS0" --mac 1 127 1 --baud 38400 --network 4 -D "bip" "eth0" --network 1
|
|
|
|
|
|
|