Skip to content

Commit

Permalink
chester: Add Getting Started, small fixes
Browse files Browse the repository at this point in the history
Signed-off-by: hubmartin <[email protected]>
  • Loading branch information
hubmartin committed Jul 26, 2024
1 parent 5d240f1 commit fb4070d
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 2 deletions.
67 changes: 67 additions & 0 deletions chester/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
slug: getting-started
title: Getting Started
---
import Image from '@theme/IdealImage';

Thank you for choosing our CHESTER device. Here are the steps on how to get started and see your data in HARDWARIO Cloud.

Current devices are shipped with the firmwares, that uses our more advanced **Cloud v2**. You can also check the firmware version you use with mobile [HARDWARIO Manager](platform-connectivity/hardwario-manager.md#show-information) or computer [HARDWARIO Monitor](platform-connectivity/hardwario-monitor.md) and if the firmware is **v3.0.0 or higher**, you have [Cloud v2](#cloud-v2) communication. Otherwise jump to the [Cloud v1](#cloud-v1) chapter.

## Cloud v2

### Create an Account

If you don't have an account:
- Go to [https://prod.hardwario.cloud/](https://prod.hardwario.cloud/)
- Click **SIGN UP**
- Create an account with **email/password**, **Google** or **Microsoft** account

### Add a Device to the Cloud

- Select the **SPACE** where you would like to add a device
- Click on the **DEVICES** in the left menu and choose [+NEW DEVICE](../cloud/cloud-v2/devices) in the top right corner

### Power-up Device

Only after you create a device in the Cloud, it will be able to talk to the Cloud and connect.

If you put batteries before the device was registered in the cloud, it might take 10 minutes or hours to connect because CHESTER has a batterry saving functionality during connection.

You might force CHESTER to connect to the network immediately by using **one of the solutions below**:

- Press the [button four times](catalog-applications/common-functionality.md#button-behaviour) to reboot the device.
- Power reset by removing and inserting batteries. When CHESTER-M has blue supercapacitors, you also need to discharge them by holding the button or pressing the [button five times](catalog-applications/common-functionality.md#button-behaviour) which turns on back-side white LED which discharges the supercapacitors within 30 seconds.

### Status LED

Watch the CHESTER [LED Behaviour](catalog-applications/common-functionality.md#led-behaviour). When LED starts blinking green every 5 seconds, it is connected to the Cloud.

### Cloud Messages

Now when you open **DEVICES** and click on the **chat icon** in your device, you will see messages from your device.

Now please follow [**Cloud v2**](../cloud/cloud-v2) documentation to assign your device and a connector a tag, then you can resend the device's data to your cloud/backend, send downlink commands, use a remote shell, FOTA and other functionalities.

In **USERS** you might also invite your co-workers and assign them a role **user** (read only) or role **admin**, which can change anything.

### Catalog Applications

Now that you have your CHESTER running, you might explore how your [catalog application](catalog-applications/index.md) works and what you can configure. Each catalog application has explained functionality. For example, CHESTER Clime has a single article with chapters: [Measurement and Behavior](catalog-applications/chester-clime.md#measurement-and-behavior), [Default Configuration](catalog-applications/chester-clime.md#default-configuration), [Specific Commands](catalog-applications/chester-clime.md#specific-commands) and [Example JSON Message](catalog-applications/chester-clime.md#example-json-message) you will see in the cloud.

For configuration, you use `config` commands in the CHESTER shell, which can be accessed either:

- Over **BLE** phone app [HARDWARIO Manager](platform-connectivity/hardwario-manager.md#command-terminal) as a Command terminal.
- Over **BLE** or **J-Link USB programmer** from your computer using [HARDWARIO Monitor](platform-connectivity/hardwario-monitor.md)
- Over HARDWARIO Cloud [config commands](../cloud/cloud-v2/downlink#config).
- Over HARDWARIO Cloud [remote shell](../cloud/cloud-v2/downlink#shell-commands).

### Troubleshooting

If you use our Vodafone SIM card in a different country than the Czech Republic, please reconfigure PLMN [based on your country](platform-connectivity/cellular-networks.md#network-settings).

In the case of using your own SIM card, after changing **PLMN** and **APN** you have also to change the [parameter to public IP](firmware-sdk/how-to-lte-v2.md#ip-and-port) for Cloud v2.

## Cloud v1

In [HARDWARIO Cloud v1](https://hardwario.cloud/) we need to make accounts manually. So if you have a CHESTER device and don't have already access to the cloud, please contact your salesperson from HARDWARIO or write to [email protected]. Please send us the HSN (HARDWARIO Serial Nuber) of the device(s) or HEO (HARDWARIO Order code) together with the email(s) for which we create an account.
9 changes: 8 additions & 1 deletion chester/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,17 @@ import Image from '@theme/IdealImage';

**HARDWARIO CHESTER** is a highly configurable IoT **LPWAN** gateway. Its primary function is to connect as many devices and environments as possible to the Internet, especially from places where there is no standard connection to the power grid and the Internet.

:::tip
### To get your CHESTER running, read the [**Getting Started**](getting-started) article.
:::

This documentation helps users and gateway integrators to navigate these essential areas:

* How to get started with CHESTER - see the article:<br/>
[**Getting Started**](getting-started)

* How to configure and manage the platform - see the article:<br/>
[**Platform Management**](category/platform-connectivity)
[**Platform Connectivity**](category/platform-connectivity)

* What ready-made firmware applications are available (with devices in stock) - see the article:<br/>
[**Catalog Applications**](catalog-applications/index.md)
Expand Down
2 changes: 1 addition & 1 deletion chester/platform-connectivity/hardwario-monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ You can import a batch of console commands with the 📄 **Batch** button on the

## Bluetooth

You can connect to the **CHESTER Shell** over Bluetooth. This is useful to change device configuration.
You can connect to the **CHESTER Shell** over Bluetooth. This is useful to use `info show` command to get firmware version or show/change device configuration using `app config show` commands.

If you cannot pair the device from the **HARDWARIO Monitor** application, you have to pair it with the system Bluetooth dialog first. Then go back to the **HARDWARIO Monitor** application
and connect to the device again.
Expand Down
1 change: 1 addition & 0 deletions sidebars-chester.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
const sidebars = {
docs: [
'introduction',
'getting-started',
{
type: 'category',
label: 'Platform Connectivity',
Expand Down

0 comments on commit fb4070d

Please sign in to comment.