Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

updates maker guide #709

Merged
merged 6 commits into from
Dec 10, 2021
Merged

updates maker guide #709

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0975452
add maker app details, updates words, adds sending HNT to maker accou…
Dec 10, 2021
ccb21ba
clean up
Dec 10, 2021
6b42645
formatting
Dec 10, 2021
a23405c
spacing
Dec 10, 2021
8027efd
one more try
Dec 10, 2021
00c7ea7
Update docs/mine-hnt/full-hotspots/become-a-maker/hotspot-integration…
cokes518 Dec 10, 2021
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
Prev Previous commit
Next Next commit
formatting
  • Loading branch information
Coco Tang authored and Coco Tang committed Dec 10, 2021
commit 6b42645f1eda0736a6579e3d1eea17a9576232ca
24 changes: 18 additions & 6 deletions docs/mine-hnt/full-hotspots/become-a-maker/hotspot-integration-testing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,10 @@ Product names on this page should follow [Helium branding guidelines](https://ww

QR Code Onboarding allows Makers to generate a partial `add_gateway` transaction outside of the Helium App. Users use the camera in the Helium App to add this type of Hotspot.

To select QR Onboarding, in the `hotspot.ts` file, specify `QR` in `onboardType`. [View the example in the Maker Starter app](https://github.com/helium/maker-starter-app/blob/f15a887afead44f2c0bba6ac7460cffebe02dc03/src/makers/example/hotspots.ts#L43)|[View the example in the Hotspot app](https://github.com/helium/hotspot-app/blob/bbcf058844965e6501295643b95021b6ef26b280/src/makers/__example__/hotspots.ts#L41) or [read more about generating QR codes](https://docs.helium.com/wallets/app-wallet/deep-links-and-qr-codes/).
To select QR Onboarding, in the `hotspot.ts` file, specify `QR` in `onboardType`.
[View the example in the Maker Starter app](https://github.com/helium/maker-starter-app/blob/f15a887afead44f2c0bba6ac7460cffebe02dc03/src/makers/example/hotspots.ts#L43)
[View the example in the Hotspot app](https://github.com/helium/hotspot-app/blob/bbcf058844965e6501295643b95021b6ef26b280/src/makers/__example__/hotspots.ts#L41)
[Read more about generating QR codes](https://docs.helium.com/wallets/app-wallet/deep-links-and-qr-codes/)

### Example QR Onboarding Flow
<img
Expand All @@ -78,18 +81,22 @@ To select QR Onboarding, in the `hotspot.ts` file, specify `QR` in `onboardType`


## Web Onboarding
Web Onboarding allows Makers to generate a partial `add_gateway` transaction outside of the Maker App. Makers generate a deep link back to the Helium App/Maker App to finish the `add_gateway` transaction. [Read more about deep linking](https://docs.helium.com/wallets/app-wallet/deep-links-and-qr-codes/).
Web Onboarding allows Makers to generate a partial `add_gateway` transaction outside of the Maker App. Makers generate a deep link back to the Helium App/Maker App to finish the `add_gateway` transaction.
[Read more about deep linking](https://docs.helium.com/wallets/app-wallet/deep-links-and-qr-codes/).

To select Web onboarding, in the `hotspot.ts` file, specify `web` in `onboardType`. [View the example in the Maker Starter app](https://github.com/helium/maker-starter-app/blob/main/src/makers/example/hotspots.ts)|[View the example in the Hotspot App](https://github.com/helium/hotspot-app/blob/bbcf058844965e6501295643b95021b6ef26b280/src/makers/__example__/hotspots.ts#L41)
To select Web onboarding, in the `hotspot.ts` file, specify `web` in `onboardType`.
[View the example in the Maker Starter app](https://github.com/helium/maker-starter-app/blob/main/src/makers/example/hotspots.ts)
[View the example in the Hotspot App](https://github.com/helium/hotspot-app/blob/bbcf058844965e6501295643b95021b6ef26b280/src/makers/__example__/hotspots.ts#L41)

## Bluetooth Pairing

The Maker App will start scanning for broadcasting Hotspots. Makers will need to update the `localname` with the product name and include the last 6 digits of the MAC identifier. The character limit is 170 but we do not recommend anyone go beyond 25-30 characters in the product name.

The `localname` is the name used on the **Found Hotspots** page.

To select Bluetooth onboarding, in the `hotspot.ts` file, specify `BLE` in `onboardType`. [View the example in the Maker Starter App](https://github.com/helium/maker-starter-app/blob/f15a887afead44f2c0bba6ac7460cffebe02dc03/src/makers/example/hotspots.ts#L6)|[View the example the Hotspot app](https://github.com/helium/hotspot-app/blob/bbcf058844965e6501295643b95021b6ef26b280/src/makers/__example__/hotspots.ts#L8).

To select Bluetooth onboarding, in the `hotspot.ts` file, specify `BLE` in `onboardType`.
[View the example in the Maker Starter App](https://github.com/helium/maker-starter-app/blob/f15a887afead44f2c0bba6ac7460cffebe02dc03/src/makers/example/hotspots.ts#L6)
[View the example the Hotspot app](https://github.com/helium/hotspot-app/blob/bbcf058844965e6501295643b95021b6ef26b280/src/makers/__example__/hotspots.ts#L8)
[Read more about BLE Services](/mine-hnt/full-hotspots/become-a-maker/hotspot-ble-services).

# Constructing the Add Gateway Transaction
Expand Down Expand Up @@ -182,6 +189,12 @@ When you’re ready to start integration with the Test Maker account with the mo
"rpi_serial":
```

`"mac_eth0": ` Ethernet MAC address
`"mac_wlan0": ` Wi-Fi MAC address
`"heliumSerial": ` Serial number for first generation Helium Hotspots. Can be ignored.
`"onboarding_key":` The onboarding key generated from the Hotspot miner in base58. Required.
`"rpi_serial": ` Serial number for the RaspberryPi. Can be repurposed to track your own serial number.

### Production

When you move to production, the JSON should be formatted like this. Note the addition of the `batch` field:
Expand All @@ -194,7 +207,6 @@ When you move to production, the JSON should be formatted like this. Note the ad
"rpi_serial": "any_value"
```


## Wallet App, Onboarding, and Data Credits

### Testing
Expand Down