Fix Typos and remove unchanged theme files (#719)
* Fix Typos and remove unchanged theme files Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Add Sandbox to getting started section * fix glitch in UI description Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>
This commit is contained in:
committed by
Dominic Schabel
parent
4dcda462b0
commit
ea7d85a15c
@@ -4,9 +4,9 @@ parent: APIs
|
||||
weight: 82
|
||||
---
|
||||
|
||||
This API is based on HTTP standards and based on a polling mechanism.
|
||||
|
||||
The hawkBit [update server](https://github.com/eclipse/hawkbit) provides REST resources which are consumed by the device to retrieve software update tasks.
|
||||
This API is based on HTTP standards and a polling mechanism.
|
||||
<!--more-->
|
||||
|
||||
{{% note %}}
|
||||
In DDI the target is identified using a **controllerId**. Controller is used as a term for the actual service/client on the device. That allows users to have in some cases even multiple clients on the same target for different tasks, e.g. Firmware update and App management.
|
||||
|
||||
@@ -4,7 +4,8 @@ parent: API
|
||||
weight: 83
|
||||
---
|
||||
|
||||
Currently bodies of messages are based on JSON. The DMF API provides java classes which allows that the message body can be deserialized at runtime into a java object. Also java classes can be used to serialize java objects into JSON bodies to send a message to hawkBit.
|
||||
The DMF API provides Java classes which allows that the message body can be deserialized at runtime into a Java object. Also Java classes can be used to serialize Java objects into JSON bodies to send a message to hawkBit.
|
||||
Currently, bodies of messages are based on JSON.
|
||||
<!--more-->
|
||||
|
||||
## Basics
|
||||
|
||||
@@ -3,6 +3,21 @@ title: Getting Started
|
||||
weight: 20
|
||||
---
|
||||
|
||||
## On Sandbox
|
||||
|
||||
We offer a sandbox installation that is free for everyone to try out hawkBit's [Management UI](/hawkbit/ui/),
|
||||
[Management API](/hawkbit/apis/management_api/), and [Direct Device Integration API](/hawkbit/apis/ddi_api/):
|
||||
**[<i class="fas fa-desktop"> </i> https://hawkbit-demo-sandbox.eu-gb.mybluemix.net/UI/](https://hawkbit-demo-sandbox.eu-gb.mybluemix.net/UI/)**
|
||||
|
||||
{{% warning %}}
|
||||
The sandbox database will be reset from time to time. It is also not possible to upload any artifacts into the sandbox. Moreover, you are not permitted to store any kind of personal data in the sandbox.
|
||||
{{% /warning %}}
|
||||
|
||||
In addition, the following vendors offer free trial accounts for their Eclipse hawkBit compatible products:
|
||||
|
||||
* [Bosch IoT Rollouts](https://www.bosch-iot-suite.com/rollouts/#plans) (by [Bosch Software Innovations GmbH](https://www.bosch-si.com/corporate/home/homepage.html))
|
||||
|
||||
|
||||
## From Docker Image
|
||||
|
||||
### Update server only
|
||||
@@ -18,24 +33,26 @@ $ git clone https://github.com/eclipse/hawkbit.git
|
||||
$ cd hawkbit/hawkbit-runtime/hawkbit-update-server/docker
|
||||
$ docker-compose up -d
|
||||
```
|
||||
{{% note %}}
|
||||
Requires Docker-Compose installed.
|
||||
{{% /note %}}
|
||||
|
||||
## From Sources
|
||||
|
||||
### Clone and build hawkBit
|
||||
### 1: Clone and build hawkBit
|
||||
```sh
|
||||
$ git clone https://github.com/eclipse/hawkbit.git
|
||||
$ cd hawkbit
|
||||
$ mvn clean install
|
||||
```
|
||||
|
||||
### Start hawkBit
|
||||
[update server](https://github.com/eclipse/hawkbit/tree/master/hawkbit-runtime/hawkbit-update-server)
|
||||
### 2: Start hawkBit [update server](https://github.com/eclipse/hawkbit/tree/master/hawkbit-runtime/hawkbit-update-server)
|
||||
|
||||
```sh
|
||||
$ java -jar ./hawkbit-runtime/hawkbit-update-server/target/hawkbit-update-server-#version#-SNAPSHOT.jar
|
||||
```
|
||||
|
||||
### Build hawkBit examples
|
||||
### 3: Build hawkBit examples
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/eclipse/hawkbit-examples.git
|
||||
@@ -43,14 +60,12 @@ $ cd hawkbit-examples
|
||||
$ mvn clean install
|
||||
```
|
||||
|
||||
### Start hawkBit device simulator
|
||||
[Device Simulator](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-device-simulator)
|
||||
### 4: Start hawkBit [Device Simulator](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-device-simulator)
|
||||
```sh
|
||||
$ java -jar ./hawkbit-device-simulator/target/hawkbit-device-simulator-#version#.jar
|
||||
```
|
||||
|
||||
### Generate Getting Started data
|
||||
[Example Management API Client](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-example-mgmt-simulator)
|
||||
### 5: Generate Getting Started data with [Example Management API Client](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-example-mgmt-simulator)
|
||||
|
||||
```sh
|
||||
$ java -jar ./hawkbit-example-mgmt-simulator/target/hawkbit-example-mgmt-simulator-#version#.jar
|
||||
|
||||
@@ -111,13 +111,13 @@ Custom target filter overview and filter management.
|
||||
|
||||
### How to Filter
|
||||
The basic syntax to filter is: `field<basic_operator>value <composite_operator> field<basic_operator>value <...>`
|
||||
|
||||
- `field`: is the name of the resource field.
|
||||
- `value`: is the value of the target field
|
||||
- `<basic_operator>`: Are operators to do simple queries. Supported basic operators are:
|
||||
- `==` : equal
|
||||
- `!=` : not equal
|
||||
- Use `=IN=` for 'in' parameter.(Example: name=IN=(target1,target2).
|
||||
|
||||
- `<composite_operator>`: Are operators to join simple queries: Supported composite operators are:
|
||||
- `and`
|
||||
- `or`
|
||||
|
||||
Reference in New Issue
Block a user