Project

General

Profile

DTXr doc » History » Version 67

Torbjorn Carlqvist Admin, 12/13/2023 02:34 PM

1 20 Torbjorn Carlqvist Admin
{{>toc}}
2
3
h1. DTXr documentation
4 1 Torbjorn Carlqvist Admin
5 5 Torbjorn Carlqvist Admin
h3. Installation
6 2 Torbjorn Carlqvist Admin
7 6 Torbjorn Carlqvist Admin
8
* System Requirements
9 21 Torbjorn Carlqvist Admin
DTXr can run on any machine that can run +Java 11+ and has sufficient with RAM and disk capacity.
10 1 Torbjorn Carlqvist Admin
11 21 Torbjorn Carlqvist Admin
|Requirement|System RAM|System DISK|Example|
12
|Minimal|512Mbyte|512Mbyte|Raspberry 1, Raspberry Zero|
13 31 Torbjorn Carlqvist Admin
|Better|512Mbyte|512Mbyte|Rasberry Zero 2|
14
|Avarage|1GByte|1Gbyte|Raspberry 2-4|
15 21 Torbjorn Carlqvist Admin
|Top|2GByte|8Gbyte|Raspberry 4, Raspberry CM4, Server, PC|
16
17 6 Torbjorn Carlqvist Admin
* Network Requirements
18
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.
19 10 Torbjorn Carlqvist Admin
20 1 Torbjorn Carlqvist Admin
* Download DTXr software packages
21 10 Torbjorn Carlqvist Admin
Currently only customers to DAVITOR can download DTXr. Contact info@davitor.com for purchase information.
22
23 15 Torbjorn Carlqvist Admin
* Install on Linux
24 60 Torbjorn Carlqvist Admin
** There is special install scripts, please follow these steps:
25 22 Torbjorn Carlqvist Admin
### Download latest DTXr _base_ image and copy to a SD-card that has 16Gbyte capacity or more
26 64 David Fredriksson
27
Or install a new image and install java
28
<pre>sudo apt install default-jdk </pre>
29
30 22 Torbjorn Carlqvist Admin
### Insert the SD card, attach keyboard and screen via cable and start the device
31 41 David Fredriksson
### When you get prompt login as **admin/davitor**
32 56 Torbjorn Carlqvist Admin
### Download the installation script from davitor repository
33 59 Torbjorn Carlqvist Admin
<pre>wget --user=**** --password=**** https://artifacts.davitor.com/repository/dtx-raw/scripts/dtx.sh</pre>
34 56 Torbjorn Carlqvist Admin
There is also a utillity script that can set the host name and MAC adress. Note, optional and only applicable on LION product appliances.
35 59 Torbjorn Carlqvist Admin
<pre>wget --user=**** --password=****  https://artifacts.davitor.com/repository/dtx-raw/scripts/system.sh</pre>
36 56 Torbjorn Carlqvist Admin
Make the scripts exec
37
<pre>sudo chmod 770 *.sh</pre>
38 57 Torbjorn Carlqvist Admin
### Run installation as below where you first alter:
39
*** Required version (-v x.y.z)
40
*** Partner user name (-u ****)
41
*** Partner password (-p ****)
42
*** Application password for the HTTP interface login on port 9090 (-app-password xxxxxxx)
43 58 Torbjorn Carlqvist Admin
*** BACnet Decvice Id (bac-device-id=nnnnn)
44 57 Torbjorn Carlqvist Admin
*** BACnet password which you will use to control the BACnet device DCC (bacnet-password=xxxxxx)
45
*** BACnet Device Name (bac-device-name=yyyy)
46 67 Torbjorn Carlqvist Admin
*** DAVITOR Reference Key (drk=xxxx) is used to mange and maintain this device from the DAVITOR PLM (Product Lifecycle Management) service. (drk=xxxx) The sequence of drk:s is in PLM instance database.
47
*** Hardware Platform Type (platform=xx) is used to control and switch on/off special features that is hardware dependent.
48 1 Torbjorn Carlqvist Admin
For LION products use:
49 67 Torbjorn Carlqvist Admin
<pre>sudo ./dtx.sh -v 3.1.17 -u **** -p **** -s "bac-device-id=nnnnn bac-device-name=yyyy app-password=xxxxxx bac-password=xxxxxx lion-enabled=true drk=xxxx platform=XX"</pre>
50 57 Torbjorn Carlqvist Admin
For other installations like PC, Servers etc. use:
51 67 Torbjorn Carlqvist Admin
<pre>sudo ./dtx.sh -v 3.1.17 -u **** -p **** -s "bac-device-id=nnnnn bac-device-name=yyyy app-password=xxxxxx bac-password=xxxxxx drk=xxxx platform=XX"</pre>
52 55 Torbjorn Carlqvist Admin
### Utillity script to set MAC and host name
53 54 Torbjorn Carlqvist Admin
<pre>sudo ./system.sh -mac 70:B3:D5:16:E8:99 -hn DTX-L1-8R8DI</pre>
54 62 Torbjorn Carlqvist Admin
* Upgrade on linux
55
If you already have DTX installed and should upgrade to a new version.
56 66 Torbjorn Carlqvist Admin
<pre>sudo ./dtx.sh -v 3.1.17 -u **** -p ****</pre>
57 55 Torbjorn Carlqvist Admin
* Manage the DTX service
58
Stop<pre>sudo systemctl stop dtx</pre>
59
Start<pre>sudo systemctl start dtx</pre>
60
Check status<pre>systemctl status dtx</pre>
61
Disable service, wont start at reboot<pre>sudo systemctl disable dtx</pre>
62
Enable service, will start automatically at reboot<pre>sudo systemctl enable dtx</pre>
63 15 Torbjorn Carlqvist Admin
64 55 Torbjorn Carlqvist Admin
* For other Linux distributions follow this steps
65 15 Torbjorn Carlqvist Admin
### _TBD..._
66
67 1 Torbjorn Carlqvist Admin
* Install on Windows
68
** Follow these steps:
69 32 David Fredriksson
### _TBD..._
70 38 Torbjorn Carlqvist Admin
71 32 David Fredriksson
h3. LION Fieldbus
72 38 Torbjorn Carlqvist Admin
73 15 Torbjorn Carlqvist Admin
* See LION [[LION:Wiki]] for howto in installataion, channel assigmnets and testing.
74 11 Torbjorn Carlqvist Admin
75 10 Torbjorn Carlqvist Admin
h3. Setup
76 11 Torbjorn Carlqvist Admin
77 1 Torbjorn Carlqvist Admin
DTXr is setup via Menu -> Setup page.
78 11 Torbjorn Carlqvist Admin
79 1 Torbjorn Carlqvist Admin
* System
80 42 David Fredriksson
** Administrator password - Password for the default (and not changeable) account  **"admin"**. Default is **"davitor"**.
81
_When you log in you will start att /home/admin
82 13 Torbjorn Carlqvist Admin
There is another user "pi" as well with a secret password._
83
** Operator username - Username for the typical user of any HMI developed on this device. Typically a machine operator. [Optional]
84
** Operator password - Password for the operator user. [Optional]
85
** Operator start page - Set any web page in the project folder that will automatically shown on an operator login. [Optional]
86 11 Torbjorn Carlqvist Admin
** Log Level - The system severity level for the system_app.log in /Logs tree directory.
87 61 Torbjorn Carlqvist Admin
** Platform - This is where DTX gets its information on which hardware options to consider.
88 11 Torbjorn Carlqvist Admin
89 14 Torbjorn Carlqvist Admin
* BACnet
90 11 Torbjorn Carlqvist Admin
** _TBD..._
91
92 14 Torbjorn Carlqvist Admin
* Davitor Advantage
93 11 Torbjorn Carlqvist Admin
** _TBD..._
94
95 14 Torbjorn Carlqvist Admin
* Wireless Mesh
96 11 Torbjorn Carlqvist Admin
** _TBD..._
97
98 14 Torbjorn Carlqvist Admin
* Bluetooth
99 11 Torbjorn Carlqvist Admin
** _TBD..._
100
101 14 Torbjorn Carlqvist Admin
* External Database Access
102 11 Torbjorn Carlqvist Admin
** _TBD..._
103
104 14 Torbjorn Carlqvist Admin
* File Integration
105 11 Torbjorn Carlqvist Admin
** _TBD..._
106
107 14 Torbjorn Carlqvist Admin
* HTTP
108 11 Torbjorn Carlqvist Admin
** _TBD..._
109
110 14 Torbjorn Carlqvist Admin
* LION Interface
111 11 Torbjorn Carlqvist Admin
** _TBD..._
112
113 14 Torbjorn Carlqvist Admin
* IoT HUB (BETA)
114 11 Torbjorn Carlqvist Admin
** _TBD..._
115 1 Torbjorn Carlqvist Admin
116
117 2 Torbjorn Carlqvist Admin
h3. User's Guide
118 14 Torbjorn Carlqvist Admin
119
* _TBD..._
120 5 Torbjorn Carlqvist Admin
121 14 Torbjorn Carlqvist Admin
h3. Developer's Guide
122 19 Torbjorn Carlqvist Admin
123
[[IDE|IDE walk through]]
124
[[Javascript|The DTXr Javascript guide]]
125 1 Torbjorn Carlqvist Admin
[[Blockly|Blockly tutorials]]