Documentation ¶
Overview ¶
Package ttjsv2 provides the claiming client implementation for The Things Join Server 2.0 API.
Index ¶
- type BasicAuth
- type Component
- type Config
- type NetworkServer
- type TTJS
- func (client *TTJS) Claim(ctx context.Context, joinEUI, devEUI types.EUI64, ...) error
- func (client *TTJS) GetClaimStatus(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers) (*ttnpb.GetClaimStatusResponse, error)
- func (client *TTJS) SupportsJoinEUI(eui types.EUI64) bool
- func (client *TTJS) Unclaim(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Component ¶
type Component interface { httpclient.Provider GetBaseConfig(ctx context.Context) config.ServiceBase GetPeerConn(ctx context.Context, role ttnpb.ClusterRole, ids cluster.EntityIdentifiers) (*grpc.ClientConn, error) AllowInsecureForCredentials() bool }
Component abstracts the underlying *component.Component.
type Config ¶
type Config struct { NetID types.NetID `yaml:"-"` JoinEUIPrefixes []types.EUI64Prefix `yaml:"-"` NetworkServer NetworkServer `yaml:"-"` BasicAuth `yaml:"basic-auth"` URL string `yaml:"url"` }
Config is the configuration to communicate with The Things Join Server End Device Claming API.
type NetworkServer ¶
NetworkServer contains information related to the Network Server.
type TTJS ¶
type TTJS struct { Component // contains filtered or unexported fields }
TTJS is a client that claims end devices on a The Things Join Server.
func (*TTJS) Claim ¶
func (client *TTJS) Claim(ctx context.Context, joinEUI, devEUI types.EUI64, claimAuthenticationCode string) error
Claim implements EndDeviceClaimer.
func (*TTJS) GetClaimStatus ¶
func (client *TTJS) GetClaimStatus( ctx context.Context, ids *ttnpb.EndDeviceIdentifiers, ) (*ttnpb.GetClaimStatusResponse, error)
GetClaimStatus implements EndDeviceClaimer.
func (*TTJS) SupportsJoinEUI ¶
SupportsJoinEUI implements EndDeviceClaimer.
Click to show internal directories.
Click to hide internal directories.