Options
All
  • Public
  • Public/Protected
  • All
Menu

Module onboarding

@helium/onboarding

npm An HTTP client for interfacing with an onboarding server

Installation

$ yarn add @helium/onboarding
# or
$ npm install @helium/onboarding

Usage

import OnboardingClient from '@helium/onboarding'
const client = new OnboardingClient()

// Or pass your own custom base url
const client = new OnboardingClient('https://onboarding.you.com/api')

const { data: record } = await client.getOnboardingRecord(hotspotAddress)
console.log(record?.publicAddress)

Index

Type Aliases

HotspotType: "IOT" | "MOBILE"
Maker: { address: string; createdAt: string; id: number; locationNonceLimit: number; name: string; updatedAt: string }

Type declaration

  • address: string
  • createdAt: string
  • id: number
  • locationNonceLimit: number
  • name: string
  • updatedAt: string
OnboardingRecord: { batch: string; code: number; createdAt: string; errorMessage: string; heliumSerial: string; id: number; macEth0: string; macWlan0: string; maker: Maker; makerId: number; onboardingKey: string; publicAddress: string; rpiSerial: string; updatedAt: string }

Type declaration

  • batch: string
  • code: number
  • createdAt: string
  • errorMessage: string
  • heliumSerial: string
  • id: number
  • macEth0: string
  • macWlan0: string
  • maker: Maker
  • makerId: number
  • onboardingKey: string
  • publicAddress: string
  • rpiSerial: string
  • updatedAt: string

Generated using TypeDoc