DTXr

{{>toc}}

h1. DTXr documentation

h3. Installation

* System Requirements

DTXr can run on any machine that can run +Java 11+ and has sufficient with RAM and disk capacity.

|Requirement|System RAM|System DISK|Example|

|Minimal|512Mbyte|512Mbyte|Raspberry 1, Raspberry Zero|

|Better|512Mbyte|512Mbyte|Rasberry Zero 2|

|Avarage|1GByte|1Gbyte|Raspberry 2-4|

|Top|2GByte|8Gbyte|Raspberry 4, Raspberry CM4, Server, PC|

* Network Requirements

DTXr can run stand alone without any active network connection. In that case the management pages is accessible via localhost interface. But for DTXr to be a fully functional BACnet/IP device it must be connected to an IP network that offers IP address via DHCP and where broadcast traffic is allowed.

* Download DTXr software packages

Currently only customers to DAVITOR can download DTXr. Contact info@davitor.com for purchase information.

* Install on Linux

** For Raspberry with Raspberry OS/Rasbian there is special install scripts, please follow these steps:

### Download latest DTXr _base_ image and copy to a SD-card that has 16Gbyte capacity or more

### Insert the SD card, attach keyboard and screen via cable and start the device

### When you get prompt login as **admin/davitor**

### Download install scripts with password for davitor sight

#### <pre>wget --user=admin --password=**** https://artifacts.davitor.com/repository/dtx-raw/scripts/dtx.sh</pre>

#### <pre>wget --user=admin --password=****  https://artifacts.davitor.com/repository/dtx-raw/scripts/system.sh</pre>

### Run installation as <pre>sudo ./dtx.sh -v 2.25 -u admin -p **** -s "bac-device-id=83336 bac-device-name=DTX-AMADA app-password=xxxxxx lion-enabled=true"

</pre>

The line above is an example where chosen parameters where set at installation and where xxxxxx is the new password for the new device to use.

### Set MAC by system.sh script

### Example:

<pre>sudo systemctl stop dtx</pre>

<pre>sudo ./system.sh -mac 70:B3:D5:16:E8:99 -hn DTX-L1-8R8DI</pre>

<pre>Setting MAC to 70:B3:D5:16:E8:99

Enabling and starting MAC service

New MAC will be effective on next reboot

Setting new hostname to DTX-L1-8R8DI

DTX-L1-8R8DI</pre>

<pre>sudo systemctl start dtx</pre>

This will excecute nesesary commands for the MAC, change the name of the node as well as change the files 

/lib/systemd/system/setmac.service

/usr/local/davitor/dtx/settings.json

*System files

**settings.json

/usr/local/davitor/dtx/settings.json

The file contains most of the important settings that is used by the DTX environment and most of it can be changed from the settingspage.

If the file is changed manually, than please stop dtx envronment by:

use of **systemctl **

sudo systemctl --help

systemctl [OPTIONS...] {COMMAND} ...

Example:

Stop

sudo systemctl stop dtx

Run

sudo systemctl start dtx

Check

systemctl status dtx.service

{

 "da-listen-hub-port": "",

 "da-listen-hub-jms-port": "",

 "bt-enabled": false,

 "jdbc-password": "",

 "bt-console-enabled": null,

 "platform": "A1",

 "iot-enabled": null,

 "app-api-token": "214751c3-8d06-4c5a-ad0a-53371bd30fad",

 "da-vnet": "",

 "reload": false,

 "jdbc-user": "",

 "app-password": "*******",

 "gateway-enabled": false,

 "file-input-folder-path": "",

 "bac-bind-addr": "0.0.0.0",

 "bac-port": 47808,

 "bac-password": "*******",

 "app-ws-port": 9091,

 "da-remote-hub-host": "",

 "bacnet-enabled": true,

 "bac-device-name": "DTX-L1-8R8DI",

 "mesh-enabled": false,

 "da-domain": "",

 "app-http-port": 9090,

 "da-remote-hub-port": "",

 "app-username": "admin",

 "jdbc-url": "",

 "lion-enabled": true,

 "jdbc-enabled": false,

 "log-level": "WARN",

 "broker-enabled": false,

 "bbmd-enabled": false,

 "bac-device-id": 83315,

 "bt-beacon-enabled": null

}

** For other Linux distributions follow this steps

### _TBD..._

* Install on Windows

** Follow these steps:

### _TBD..._

h3. LION Fieldbus

* See LION [[LION:Wiki]] for howto in installataion, channel assigmnets and testing.

h3. Setup

DTXr is setup via Menu -> Setup page.

* System

** Administrator password - Password for the default (and not changeable) account  **"admin"**. Default is **"davitor"**.

_When you log in you will start att /home/admin

There is another user "pi" as well with a secret password._

** Operator username - Username for the typical user of any HMI developed on this device. Typically a machine operator. [Optional]

** Operator password - Password for the operator user. [Optional]

** Operator start page - Set any web page in the project folder that will automatically shown on an operator login. [Optional]

** Log Level - The system severity level for the system_app.log in /Logs tree directory.

* BACnet

** _TBD..._

* Davitor Advantage

** _TBD..._

* Wireless Mesh

** _TBD..._

* Bluetooth

** _TBD..._

* External Database Access

** _TBD..._

* File Integration

** _TBD..._

* HTTP

** _TBD..._

* LION Interface

** _TBD..._

* IoT HUB (BETA)

** _TBD..._

h3. User's Guide

* _TBD..._

h3. Developer's Guide

[[IDE|IDE walk through]]

[[Javascript|The DTXr Javascript guide]]

[[Blockly|Blockly tutorials]]