Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/network-data/oracle-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ image: https://docs.helium.com/img/link-image.png
slug: /network-data/oracle-data
---

The Helium Network operates Oracles that perform various tasks backing Proof-of-Coverage and data
transfer for the LoRaWAN (IOT), Mobile, and any future networks. These Oracles provide extensive
logs for analysis of the Helium subnetworks.
The Helium Network operates Oracles that perform various tasks backing data transfer and
Proof-of-Coverage across the Helium subnetworks. These Oracles provide extensive logs for analysis
of the Helium subnetworks.

The Helium Oracles handle all data about the network, except for transactions handled by the
[Helium Program Libraries](https://github.com/helium/helium-program-library) on Solana.
Expand Down
2 changes: 1 addition & 1 deletion docs/network-data/solana-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ published March 20, 2023. The audit report is available from sec3 on their

- Program ID: `hdaoVTCqhfHHo75XdAMxBKdUqvq1i5bF23sisBqVgGR`
- Manages the DAO/subnetwork structure proposed in HIP-51, including the minting of tokens to
subnetworks, HST holders, and the `lazy_distributor` for PoC earnings.
subnetworks, HST holders, and the `lazy_distributor` for reward earnings.

#### lazy_distributor

Expand Down
3 changes: 2 additions & 1 deletion docs/network-data/solana/rewardable-entities.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,8 @@ describe("onboarding server", () => {
## Claiming Rewards on Rewardable Entities

A system of oracles keeps track of the rewards owed to each Rewardable Entity. For example, in the
IoT network there are oracles that keep track of the HNT tokens earned by each Hotspot for PoC.
IoT network there are oracles that keep track of the HNT tokens earned by each Hotspot for
transferring data.

These oracles are responsible ONLY for tracking the total lifetime rewards associated with a
Hotspot. This frees the oracles from any kind of dependence on the blockchain. They don't care about
Expand Down
107 changes: 0 additions & 107 deletions docs/network-iot/hotspots-iot/data-only-hotspots.mdx

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,34 +1,35 @@
---
id: data-only-hotspots-onboarding
title: Data-Only Hotspot Onboarding
pagination_label: Data-Only Hotspot Onboarding
sidebar_label: Data-Only Hotspot Onboarding
id: on-device-onboarding
title: On-Device Onboarding
pagination_label: On-Device Onboarding
sidebar_label: On-Device (gateway-rs)
description:
Step-by-step guide for onboarding a data-only Hotspot using gateway-rs and the Helium CLI Wallet.
Onboard a single Hotspot by running gateway-rs on the gateway and submitting the add and
assert-location transactions with the Helium CLI Wallet.
image: https://docs.helium.com/img/link-image.png
slug: /iot/data-only-hotspots-onboarding
slug: /iot/onboard-a-hotspot/on-device
---

import useBaseUrl from '@docusaurus/useBaseUrl'

# Data-Only Hotspot Onboarding

<img className="docsheader" src={useBaseUrl('img/network-iot/data-only-onboarding-header.png')} />
<br />
<br />

This guide walks through the process of onboarding a Data-Only Hotspot to the Helium Network. The
onboarding procedure expects a gateway configured with the Semtech Packet Forwarder and Helium
Gateway-rs.
This guide covers onboarding with gateway-rs, where the client runs on the gateway itself and holds
the key. It assumes the gateway already has the Semtech packet forwarder and gateway-rs installed.
The add and assert-location steps below are the on-chain onboarding, and they are the same for every
Hotspot — here the gateway-rs key on the device signs the add transaction. To run the software on a
server for a fleet instead, see [Server Onboarding](/iot/onboard-a-hotspot/server).

## Prerequisites

- LoRaWAN Gateway with Gateway-rs installed.
- Helium Wallet CLI with a funded account imported.
- Token balances to onboard a Data-Only Hotspot.
- Token balances to onboard a Hotspot.
- 100,000 ($1) Data Credits (DCs) comprised of
- 50,000 ($0.50) Data-Only Onboard
- 50,000 ($0.50) Data-Only Location Assert
- 50,000 ($0.50) to add a Hotspot
- 50,000 ($0.50) to assert its location
- SOL (Solana's native cryptocurrency) to cover transaction fees (~0.01 Sol)

## Installing Gateway-rs
Expand Down Expand Up @@ -292,7 +293,7 @@ Make sure the paying account has at least 50,000 Data Credits available to compl
assert transaction. The transactions take place on the Solana blockchain, so a small amount of SOL
is also required to cover Solana fees.

Before running the assert command, get the public key from the Data-Only Hotspot.
Before running the assert command, get the public key from the Hotspot.

```sh
helium_gateway key info
Expand Down
91 changes: 91 additions & 0 deletions docs/network-iot/hotspots-iot/onboard-a-hotspot.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
id: onboard-a-hotspot
title: Onboard a Hotspot
pagination_label: Onboard a Hotspot
sidebar_label: Overview
description:
How to add a LoRaWAN gateway to the Helium IoT Network as a Hotspot — on-device with gateway-rs,
or on a server with multi-gateway.
image: https://docs.helium.com/img/link-image.png
slug: /iot/onboard-a-hotspot
---

import useBaseUrl from '@docusaurus/useBaseUrl'

<img className="docsheader" src={useBaseUrl('img/network-iot/data-only-header.png')} />
<br />
<br />

Any LoRaWAN gateway can join the Helium IoT Network as a Hotspot and earn HNT for the device data it
carries. Onboarding is permissionless and the same for every Hotspot: add it to a wallet and assert
its location with the [CLI Wallet](/wallets/cli-wallet).

## Two ways to run a Hotspot

What differs between setups is where the Helium gateway software runs, and which client holds the
key that signs the add transaction. Choose based on how many gateways you're bringing online.

- **gateway-rs, on the gateway.** The client runs on the gateway itself, next to its packet
forwarder, and the key lives on the device. Best for a single Hotspot or a handful. See
[On-Device Onboarding](/iot/onboard-a-hotspot/on-device).
- **multi-gateway, on a server.** One server fronts many gateways and holds a key for each. The
gateways run a standard packet forwarder pointed at the server. Best for fleets. See
[Server Onboarding](/iot/onboard-a-hotspot/server).

## Architecture

[gateway-rs](https://github.com/helium/gateway-rs) is a lightweight client that runs on the gateway,
next to its packet forwarder.

```mermaid
graph LR;
subgraph Gateway["Helium-Enabled Gateway (Hotspot)"]
PacketForwarder["Packet<br>Forwarder"]
HeliumGateway["Helium<br>Gateway-rs"]

PacketForwarder -- "Semtech GWMP<br>over UDP" --> HeliumGateway
end

HeliumRouter["Helium<br>Packet Router"]
LNS["LoRaWAN<br>Network Server"]

HeliumGateway -- "gRPC" --> HeliumRouter
HeliumRouter --> LNS
```

The packet forwarder sends LoRaWAN packets to gateway-rs over Semtech GWMP. Gateway-rs signs each
packet and forwards it to the Helium Packet Router, which routes it to a LoRaWAN Network Server
(LNS). For the latest releases and build notes, see the gateway-rs
[readme](https://github.com/helium/gateway-rs/blob/main/README.md).

## Packet forwarder setup

A Hotspot needs a [Semtech packet forwarder](https://github.com/helium/packet_forwarder) on the
gateway. If the hardware does not already have one, follow a hardware guide below. These guides
point the packet forwarder at gateway-rs on the same device; for the server method, point it at your
multi-gateway server instead.

- [Dragino LPS8/DLOS8](/iot/packet-forwarders/dragino)
- [RAKwireless Concentrator (RAK2245/RAK2247/RAK2287) + Raspberry Pi](/iot/packet-forwarders/rak-concentrators)
- [Using Balena: RAKwireless RAK2287 Concentrator + Raspberry Pi](/iot/packet-forwarders/balena)
- [RAKwireless WisGate Edge Lite 2](https://github.com/HoBoWAN/Helium-Data-Only-Hotspot/blob/main/README.md)
- [Seeed Studio SenseCAP M2](https://wiki.seeedstudio.com/Network/SenseCAP_Network/SenseCAP_M2_Data_Only-Helium_gateway/SenseCAP_M2_Data_Only_Quick_Start/)

## Cost

Two transactions bring a Hotspot online. The **Add Hotspot** transaction links the Hotspot's key
(`swarm_key`) to a [wallet](/wallets) and makes the Hotspot known to the network. The **Assert
Location** transaction provides the physical location (lat/long), elevation (in meters), and antenna
EIRP (in dBi). A Hotspot must be onboarded before its location can be asserted.

- **Add Hotspot**: 50,000 Data Credits (USD \$0.50)
- **Assert Location**: 50,000 Data Credits (USD \$0.50)

These fees are paid using [Data Credits](/tokens/data-credit).

Transactions are submitted using the [CLI Wallet](/wallets/cli-wallet). The CLI Wallet should
**not** be installed on the gateway, doing so could expose account keys to the open internet if the
gateway is not properly secured. Existing accounts generated using the Helium Wallet App can be
[imported to the CLI](/wallets/cli-wallet#import-seed-phrase-account-into-cli).

For the step-by-step, see [On-Device Onboarding](/iot/onboard-a-hotspot/on-device).
Loading