provisioningapi

package
v0.0.0-...-0aa8592 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 25, 2025 License: AGPL-3.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BadResponse

type BadResponse struct {
	Err     string `json:"err"`
	ErrCode int    `json:"err_code"`
}

type ClaimData

type ClaimData struct {
	BLEMac         string `json:"ble_mac"`
	BoardToken     string `json:"board_token"`
	ConnectionType string `json:"connection_type"`
	DeviceName     string `json:"device_name"`
}

type ClaimResponse

type ClaimResponse struct {
	OnboardId string `json:"id"`
}

type Onboarding

type Onboarding struct {
	ID               string  `json:"id"`
	UniqueHardwareID string  `json:"unique_hardware_id"`
	DeviceName       string  `json:"device_name"`
	ConnectionType   string  `json:"connection_type"`
	DeviceID         *string `json:"device_id"`
	UserID           string  `json:"user_id"`
	OrgID            *string `json:"org_id"`
	BLEMac           string  `json:"ble_mac"`
	CreatedAt        string  `json:"created_at"`
	ProvisionedAt    *string `json:"provisioned_at"`
	ClaimedAt        string  `json:"claimed_at"`
	EndedAt          *string `json:"ended_at"`
	FQBN             string  `json:"fqbn"`
}

type OnboardingsResponse

type OnboardingsResponse struct {
	Onboardings []Onboarding `json:"onboardings"`
}

type ProvisioningApiClient

type ProvisioningApiClient struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(credentials *config.Credentials) *ProvisioningApiClient

func (*ProvisioningApiClient) ClaimDevice

func (c *ProvisioningApiClient) ClaimDevice(data ClaimData) (*ClaimResponse, *BadResponse, error)

func (*ProvisioningApiClient) GetProvisioningDetail

func (c *ProvisioningApiClient) GetProvisioningDetail(provID string) (*Onboarding, error)

func (*ProvisioningApiClient) GetProvisioningList

func (c *ProvisioningApiClient) GetProvisioningList() (*OnboardingsResponse, error)

func (*ProvisioningApiClient) RegisterDevice

func (c *ProvisioningApiClient) RegisterDevice(data RegisterBoardData) (*BadResponse, error)

func (*ProvisioningApiClient) UnclaimDevice

func (c *ProvisioningApiClient) UnclaimDevice(provisioningId string) (*BadResponse, error)

type RegisterBoardData

type RegisterBoardData struct {
	PID              string  `json:"pid"`
	PublicKey        string  `json:"public_key"`
	Serial           *string `json:"serial"`
	UniqueHardwareID string  `json:"unique_hardware_id"`
	VID              string  `json:"vid"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL