Skip to content

Commit

Permalink
Update asset management. Update images. Add 1.3.1 upgrade/installatio…
Browse files Browse the repository at this point in the history
…n instructions.
  • Loading branch information
ikulikov committed Oct 16, 2017
1 parent 96f99bd commit d93c57e
Show file tree
Hide file tree
Showing 23 changed files with 197 additions and 33 deletions.
1 change: 1 addition & 0 deletions _includes/head-header.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
{% endif %}
{% if !page.no_canonical %}<link rel="canonical" href="https://thingsboard.io{{page.url}}" />{% endif %}
<link rel="shortcut icon" type="image/png" href="/images/favicon.png">
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700" rel="stylesheet">
<link rel="stylesheet" href="/css/styles.css">
<script type="text/javascript">
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
wget https://github.com/thingsboard/thingsboard/releases/download/v1.3.1/thingsboard-1.3.1.rpm
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sudo rpm -Uvh thingsboard-1.3.1.rpm
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
wget https://github.com/thingsboard/thingsboard/releases/download/v1.3.1/thingsboard-1.3.1.deb
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sudo dpkg -i thingsboard-1.3.1.deb
Original file line number Diff line number Diff line change
@@ -1 +1 @@
wget https://github.com/thingsboard/thingsboard/releases/download/v1.3/thingsboard-1.3.rpm
wget https://github.com/thingsboard/thingsboard/releases/download/v1.3.1/thingsboard-1.3.1.rpm
Original file line number Diff line number Diff line change
@@ -1 +1 @@
sudo rpm -Uvh thingsboard-1.3.rpm
sudo rpm -Uvh thingsboard-1.3.1.rpm
Original file line number Diff line number Diff line change
@@ -1 +1 @@
wget https://github.com/thingsboard/thingsboard/releases/download/v1.3/thingsboard-1.3.deb
wget https://github.com/thingsboard/thingsboard/releases/download/v1.3.1/thingsboard-1.3.1.deb
Original file line number Diff line number Diff line change
@@ -1 +1 @@
sudo dpkg -i thingsboard-1.3.deb
sudo dpkg -i thingsboard-1.3.1.deb
4 changes: 2 additions & 2 deletions docs/user-guide/install/rpi.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ Download installation package or [build it from source](/docs/user-guide/install

```bash
# Download the package
$ wget https://github.com/thingsboard/thingsboard/releases/download/v1.3/thingsboard-1.3.deb
$ wget https://github.com/thingsboard/thingsboard/releases/download/v1.3.1/thingsboard-1.3.1.deb
# Install ThingsBoard as a service
$ sudo dpkg -i thingsboard-1.3.deb
$ sudo dpkg -i thingsboard-1.3.1.deb
# Update ThingsBoard memory usage and restrict it to 150MB in /etc/thingsboard/conf/thingsboard.conf
export JAVA_OPTS="$JAVA_OPTS -Dplatform=rpi -Xms256M -Xmx256M"
```
Expand Down
89 changes: 89 additions & 0 deletions docs/user-guide/install/upgrade-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,17 @@ description: ThingsBoard IoT platform upgrade instructions
</li>
</ul>
</li>
<li>
<a href="#upgrading-to-131" id="markdown-toc-upgrading-to-131">Upgrading to 1.3.1</a>
<ul>
<li>
<a href="#ubuntucentos-5" id="markdown-toc-ubuntucentos-5">Ubuntu/CentOS</a>
</li>
<li>
<a href="#windows-5" id="markdown-toc-windows-5">Windows</a>
</li>
</ul>
</li>
</ul>

## Upgrading to 1.0.3
Expand Down Expand Up @@ -555,3 +566,81 @@ C:\thingsboard>upgrade.bat --fromVersion=1.2.3
```text
net start thingsboard
```

## Upgrading to 1.3.1

These steps are applicable for 1.3.0 ThingsBoard version.

### Ubuntu/CentOS

#### ThingsBoard package download

{% capture tabspec %}thingsboard-download-1-3-1
thingsboard-download-1-3-1-ubuntu,Ubuntu,shell,resources/1.3.1/thingsboard-ubuntu-download.sh,/docs/user-guide/install/resources/1.3.1/thingsboard-ubuntu-download.sh
thingsboard-download-1-3-1-centos,CentOS,shell,resources/1.3.1/thingsboard-centos-download.sh,/docs/user-guide/install/resources/1.3.1/thingsboard-centos-download.sh{% endcapture %}
{% include tabs.html %}

#### ThingsBoard service upgrade

{% capture tabspec %}thingsboard-installation-1-3-1
thingsboard-installation-1-3-1-ubuntu,Ubuntu,shell,resources/1.3.1/thingsboard-ubuntu-installation.sh,/docs/user-guide/install/resources/1.3.1/thingsboard-ubuntu-installation.sh
thingsboard-installation-1-3-1-centos,CentOS,shell,resources/1.3.1/thingsboard-centos-installation.sh,/docs/user-guide/install/resources/1.3.1/thingsboard-centos-installation.sh{% endcapture %}
{% include tabs.html %}

**NOTE:** Package installer may ask you to merge your thingsboard configuration. It is preferred to use **merge option** to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.type parameter value (in the file **/etc/thingsboard/conf/thingsboard.yml**) to "cassandra" instead of "sql" in order to upgrade your cassandra database:

```
database:
type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql
```

```bash
# Execute upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=1.3.0
```

#### Start the service

```bash
$ sudo service thingsboard start
```

### Windows

#### ThingsBoard package download

Download ThingsBoard installation archive for Windows: [thingsboard-windows-1.3.1.zip](https://github.com/thingsboard/thingsboard/releases/download/v1.3.1/thingsboard-windows-1.3.1.zip).

#### ThingsBoard service upgrade

* Stop ThingsBoard service if it is running.

```text
net stop thingsboard
```

* Make a backup of previous ThingsBoard configuration located in \<ThingsBoard install dir\>\conf (for ex. C:\thingsboard\conf).

* Remove ThingsBoard install dir.
* Unzip installation archive to ThingsBoard install dir.
* Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
* Please make sure that you set database.type parameter value (in the file **\<ThingsBoard install dir\>\conf\thingsboard.yml**) to "cassandra" instead of "sql" in order to upgrade your cassandra database:

```
database:
type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql
```
* Run **upgrade.bat** script to upgrade ThingsBoard to the new version.

**NOTE** Scripts listed above should be executed using Administrator Role.

```text
C:\thingsboard>upgrade.bat --fromVersion=1.3.0
```

#### Start the service

```text
net start thingsboard
```
4 changes: 2 additions & 2 deletions docs/user-guide/install/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Instructions listed below will help you to install Cassandra.
#### ThingsBoard service installation

- Create working directory, for example "C:\thingsboard".
- Download [installation archive](https://github.com/thingsboard/thingsboard/releases/download/v1.3/thingsboard-windows-1.3.zip) or [build it from source](/docs/user-guide/install/building-from-source).
- Download [installation archive](https://github.com/thingsboard/thingsboard/releases/download/v1.3.1/thingsboard-windows-1.3.1.zip) or [build it from source](/docs/user-guide/install/building-from-source).
- Unzip installation archive to the working directory. The working directory should look like this after installation:

![image](/images/user-guide/install/windows/windows-folder.png)
Expand All @@ -105,7 +105,7 @@ Instructions listed below will help you to install Cassandra.
Java 1.8 found!
Installing thingsboard ...
===================================================
:: ThingsBoard :: (v1.3.0)
:: ThingsBoard :: (v1.3.1)
===================================================
Starting ThingsBoard Installation...
Expand Down
1 change: 1 addition & 0 deletions docs/user-guide/ui/tenants.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ System administrator is also able to create multiple [users](/docs/user-guide/ui
Tenant Administrator is able to do following actions:

- Provision and Manage [Devices](/docs/user-guide/ui/devices).
- Provision and Manage [Assets](/docs/user-guide/ui/assets).
- Create and Manage [Customers](/docs/user-guide/ui/customers).
- Create and Manage [Dashboards](/docs/user-guide/ui/dashboards).
- Configure [Rules](/docs/user-guide/ui/rules) and [Plugins](/docs/user-guide/ui/plugins)
Expand Down
6 changes: 6 additions & 0 deletions docs/user-guide/ui/widget-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,12 @@ Useful for visualization and control of GPIO state for target devices.

![image](/images/user-guide/ui/gpio-widgets.png)

### Control widgets

Useful for visualize current state and send RPC commands to target devices.

![image](/images/user-guide/ui/control-widgets.png)

### Maps widgets

Useful for visualization of devices geo locations and track devices routes both in real-time and history mode.
Expand Down
65 changes: 61 additions & 4 deletions images/user-guide/entities-and-relations.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/user-guide/ui/analog-gauges.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/user-guide/ui/cards.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/user-guide/ui/charts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/user-guide/ui/control-widgets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/user-guide/ui/digital-gauges.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/user-guide/ui/gpio-widgets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/user-guide/ui/maps-widgets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 27 additions & 21 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -191,8 +191,9 @@ <h3 class="center">Real-Time IoT Dashboards</h3>
<main>
<div class="image-wrapper"><img src="images/device_management.png"></div>
<div class="content">
<h4>Provision and manage devices</h4>
<p>Provision, monitor and control your devices in secure way using rich server-side APIs.</p>
<h4>Provision and manage devices and assets</h4>
<p>Provision, monitor and control your IoT entities in secure way using rich server-side APIs.
Define relations between your devices, assets, customers or any other entities.</p>
</div>
</main>
<main>
Expand All @@ -208,7 +209,7 @@ <h4>Collect and visualize data</h4>
<div class="image-wrapper"><img src="images/process_react.png"></div>
<div class="content">
<h4>Process and React</h4>
<p>Define data processing rules and trigger reactions using plugins.</p>
<p>Define data processing rules and trigger reactions using plugins. Raise alarms on incoming telemetry events or attribute updates.</p>
</div>
</main>
<main>
Expand All @@ -231,9 +232,8 @@ <h4><a href="/docs/user-guide/telemetry/">Telemetry Data Collection</a></h4>
Access collected data using customizable web dashboards or server-side APIs.</p>
</div>
<div>
<h4><a href="docs/reference/architecture/#clustering-mode">Horizontal scalability</a></h4>
<p>Amount of supported server-side requests and devices increase linearly as new thingsboard servers are added in clustering mode.
No downtime, server restarts or application errors.</p>
<h4><a href="/docs/user-guide/ui/tenants/">Multi-tenancy</a></h4>
<p>Support multi-tenant installations out-of-the-box. Single tenant may have multiple tenant administrators and millions of devices and customers.</p>
</div>
</div>

Expand All @@ -244,9 +244,9 @@ <h4><a href="/docs/user-guide/visualization/">Data Visualization</a></h4>
Built-in line-charts, digital and analog gauges, maps and much more.</p>
</div>
<div>
<h4><a href="docs/reference/architecture/#service-discovery">Fault-tolerance</a></h4>
<p>All thingsboard servers are identical. No master-workers or hot standby. Node failure is automatically detected.
Failed nodes can be replaced without downtime. Persisted data is replicated using reliable NoSQL database.</p>
<h4><a href="docs/reference/architecture/#clustering-mode">Horizontal scalability</a></h4>
<p>Amount of supported server-side requests and devices increase linearly as new thingsboard servers are added in clustering mode.
No downtime, server restarts or application errors.</p>
</div>
</div>

Expand All @@ -257,9 +257,11 @@ <h4><a href="docs/user-guide/rule-engine/">IoT Rule Engine</a></h4>
Forward data to external systems or trigger alarms using rules.
Enrich server-side functionality or send commands to devices using plugins.</p>
</div>

<div>
<h4><a href="/docs/reference/architecture/#security">Security</a></h4>
<p>Supports transport encryption for both MQTT and HTTP(s) protocols. Supports device authentication and device credentials management.</p>
<h4><a href="docs/reference/architecture/#service-discovery">Fault-tolerance</a></h4>
<p>All thingsboard servers are identical. No master-workers or hot standby. Node failure is automatically detected.
Failed nodes can be replaced without downtime. Persisted data is replicated using reliable NoSQL database.</p>
</div>
</div>

Expand All @@ -269,33 +271,37 @@ <h4><a href="/docs/user-guide/ui/devices/">Device Management</a></h4>
<p>Provides ability to register and manage <a href="/docs/user-guide/ui/devices/">devices</a>. Allows to monitor client-side and provision server-side <a href="/docs/user-guide/attributes/">device attributes</a>.
Provides API for server-side applications to send <a href="/docs/user-guide/rpc/">RPC commands</a> to devices and vice-versa.</p>
</div>

<div>
<h4><a href="/docs/user-guide/customization/">Customization and Integration</a></h4>
<p>Extend default platform functionality using customizable <a href="docs/user-guide/rule-engine/#rules">rules</a>,
<a href="docs/user-guide/rule-engine/#plugins">plugins</a>, <a href="docs/user-guide/ui/widget-library/">widgets</a> and <a href="docs/reference/protocols/">transport implementations</a>.
In addition to MQTT, CoAP and HTTP support, ThingsBoard users can use their own transport implementations or customize behaviour of existing protocols.</p>
<h4><a href="/docs/reference/architecture/#security">Security</a></h4>
<p>Supports transport encryption for both MQTT and HTTP(s) protocols. Supports device authentication and device credentials management.</p>
</div>
</div>

<div class="feature-box">
<div>
<h4><a href="/docs/user-guide/ui/assets/">Asset Management</a></h4>
<p>Provides ability to register and manage <a href="/docs/user-guide/ui/assets/">assets</a>. Allows to provision server-side <a href="/docs/user-guide/attributes/">asset attributes</a>
and monitor <a href="docs/user-guide/alarms/">alarms</a>.
and monitor related <a href="docs/user-guide/alarms/">alarms</a>. Ability to build hierarchy of entities using <a href="/docs/user-guide/entities-and-relations/">relations</a>.
</div>
<div>
<h4><a href="https://github.com/thingsboard/thingsboard">100&#37; Open-source</a></h4>
<p>ThingsBoard is licensed under Apache License 2.0, so you can use any it in your commercial products for free.
You can even host it as a SaaS or PaaS solution.</p>
<h4><a href="/docs/user-guide/customization/">Customization and Integration</a></h4>
<p>Extend default platform functionality using customizable <a href="docs/user-guide/rule-engine/#rules">rules</a>,
<a href="docs/user-guide/rule-engine/#plugins">plugins</a>, <a href="docs/user-guide/ui/widget-library/">widgets</a> and <a href="docs/reference/protocols/">transport implementations</a>.
In addition to MQTT, CoAP and HTTP support, ThingsBoard users can use their own transport implementations or customize behaviour of existing protocols.</p>
</div>
</div>

<div class="feature-box">
<div>
<h4><a href="/docs/user-guide/ui/tenants/">Multi-tenancy</a></h4>
<p>Support multi-tenant installations out-of-the-box. Single tenant may have multiple tenant administrators and millions of devices and customers.</p>
<h4><a href="/docs/user-guide/alarms/">Alarms Management</a></h4>
<p>Provides ability to create and manage <a href="/docs/user-guide/alarms/">alarms</a> related to your entities: devices, assets, customers, etc.
Allows real-time alarms monitoring and alarms propagation to related entities hierarchy.
</div>
<div>
<h4><a href="https://github.com/thingsboard/thingsboard">100&#37; Open-source</a></h4>
<p>ThingsBoard is licensed under Apache License 2.0, so you can use any it in your commercial products for free.
You can even host it as a SaaS or PaaS solution.</p>
</div>
</div>

Expand Down

0 comments on commit d93c57e

Please sign in to comment.