Project

General

Profile

DTXr doc » History » Version 71

David Fredriksson, 05/02/2024 11:22 AM

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 69 Torbjorn Carlqvist Admin
### Download the installation script from davitor repository *(note dtx.sh has an update since Jan 17th, 2024 see new parameter _installfolder_ below)*
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 1 Torbjorn Carlqvist Admin
*** Required version (-v x.y.z)
40 69 Torbjorn Carlqvist Admin
*** The the install folder (-f myfolder) Note: Still relative to /usr/local so (-f myfolder) results in /usr/local/myfolder/dtx...
41 57 Torbjorn Carlqvist Admin
*** Partner user name (-u ****)
42
*** Partner password (-p ****)
43
*** Application password for the HTTP interface login on port 9090 (-app-password xxxxxxx)
44 58 Torbjorn Carlqvist Admin
*** BACnet Decvice Id (bac-device-id=nnnnn)
45 57 Torbjorn Carlqvist Admin
*** BACnet password which you will use to control the BACnet device DCC (bacnet-password=xxxxxx)
46
*** BACnet Device Name (bac-device-name=yyyy)
47 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.
48 1 Torbjorn Carlqvist Admin
*** Hardware Platform Type (platform=xx) is used to control and switch on/off special features that is hardware dependent.
49
For LION products use:
50 71 David Fredriksson
<pre>sudo ./dtx.sh -v 3.1.23 -f myfolder -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>
51 57 Torbjorn Carlqvist Admin
For other installations like PC, Servers etc. use:
52 71 David Fredriksson
<pre>sudo ./dtx.sh -v 3.1.23 -f myfolder -u **** -p **** -s "bac-device-id=nnnnn bac-device-name=yyyy app-password=xxxxxx bac-password=xxxxxx drk=xxxx platform=XX"</pre>
53 55 Torbjorn Carlqvist Admin
### Utillity script to set MAC and host name
54 54 Torbjorn Carlqvist Admin
<pre>sudo ./system.sh -mac 70:B3:D5:16:E8:99 -hn DTX-L1-8R8DI</pre>
55 62 Torbjorn Carlqvist Admin
* Upgrade on linux
56 69 Torbjorn Carlqvist Admin
If you already have DTX installed and should upgrade to a new version *(Don't forget to set correct installfolder with -f)*
57 71 David Fredriksson
<pre>sudo ./dtx.sh -v 3.1.23 -f myfolder -u **** -p ****</pre>
58 69 Torbjorn Carlqvist Admin
* Manage the DTX service *(Note, since 17th Jan, 2024 of dtx.sh the names of the services are appended with the instsall folder in order to install multiple instances of DTX in same machine.)*
59 70 Torbjorn Carlqvist Admin
Stop<pre>sudo systemctl stop dtx_{myfolder}</pre> 
60
Start<pre>sudo systemctl start dtx_{myfolder}</pre>
61
Check status<pre>systemctl status dtx_{myfolder}</pre>
62
Disable service, wont start at reboot<pre>sudo systemctl disable dtx_{myfolder}</pre>
63
Enable service, will start automatically at reboot<pre>sudo systemctl enable dtx_{myfolder}</pre>
64 15 Torbjorn Carlqvist Admin
65 55 Torbjorn Carlqvist Admin
* For other Linux distributions follow this steps
66 15 Torbjorn Carlqvist Admin
### _TBD..._
67
68 1 Torbjorn Carlqvist Admin
* Install on Windows
69
** Follow these steps:
70 32 David Fredriksson
### _TBD..._
71 38 Torbjorn Carlqvist Admin
72 32 David Fredriksson
h3. LION Fieldbus
73 38 Torbjorn Carlqvist Admin
74 15 Torbjorn Carlqvist Admin
* See LION [[LION:Wiki]] for howto in installataion, channel assigmnets and testing.
75 11 Torbjorn Carlqvist Admin
76 10 Torbjorn Carlqvist Admin
h3. Setup
77 11 Torbjorn Carlqvist Admin
78 1 Torbjorn Carlqvist Admin
DTXr is setup via Menu -> Setup page.
79 11 Torbjorn Carlqvist Admin
80 1 Torbjorn Carlqvist Admin
* System
81 42 David Fredriksson
** Administrator password - Password for the default (and not changeable) account  **"admin"**. Default is **"davitor"**.
82
_When you log in you will start att /home/admin
83 13 Torbjorn Carlqvist Admin
There is another user "pi" as well with a secret password._
84
** Operator username - Username for the typical user of any HMI developed on this device. Typically a machine operator. [Optional]
85
** Operator password - Password for the operator user. [Optional]
86
** Operator start page - Set any web page in the project folder that will automatically shown on an operator login. [Optional]
87 11 Torbjorn Carlqvist Admin
** Log Level - The system severity level for the system_app.log in /Logs tree directory.
88 61 Torbjorn Carlqvist Admin
** Platform - This is where DTX gets its information on which hardware options to consider.
89 11 Torbjorn Carlqvist Admin
90 14 Torbjorn Carlqvist Admin
* BACnet
91 11 Torbjorn Carlqvist Admin
** _TBD..._
92
93 14 Torbjorn Carlqvist Admin
* Davitor Advantage
94 11 Torbjorn Carlqvist Admin
** _TBD..._
95
96 14 Torbjorn Carlqvist Admin
* Wireless Mesh
97 11 Torbjorn Carlqvist Admin
** _TBD..._
98
99 14 Torbjorn Carlqvist Admin
* Bluetooth
100 11 Torbjorn Carlqvist Admin
** _TBD..._
101
102 14 Torbjorn Carlqvist Admin
* External Database Access
103 11 Torbjorn Carlqvist Admin
** _TBD..._
104
105 14 Torbjorn Carlqvist Admin
* File Integration
106 11 Torbjorn Carlqvist Admin
** _TBD..._
107
108 14 Torbjorn Carlqvist Admin
* HTTP
109 11 Torbjorn Carlqvist Admin
** _TBD..._
110
111 14 Torbjorn Carlqvist Admin
* LION Interface
112 11 Torbjorn Carlqvist Admin
** _TBD..._
113
114 14 Torbjorn Carlqvist Admin
* IoT HUB (BETA)
115 11 Torbjorn Carlqvist Admin
** _TBD..._
116 1 Torbjorn Carlqvist Admin
117
118 2 Torbjorn Carlqvist Admin
h3. User's Guide
119 14 Torbjorn Carlqvist Admin
120
* _TBD..._
121 5 Torbjorn Carlqvist Admin
122 14 Torbjorn Carlqvist Admin
h3. Developer's Guide
123 19 Torbjorn Carlqvist Admin
124
[[IDE|IDE walk through]]
125
[[Javascript|The DTXr Javascript guide]]
126 1 Torbjorn Carlqvist Admin
[[Blockly|Blockly tutorials]]