objects

Documentation

Index

• type DeviceUplinkResponse
• type DeviceUplinkResponses
  • func (d DeviceUplinkResponses) UnmarshalJSON(b []byte) error
• type DeviceUplinks
  • func (u DeviceUplinks) MarshalJSON() ([]byte, error)
• type EUI
  • func (e EUI) MarshalJSON() ([]byte, error)
  • func (e EUI) String() string
  • func (e *EUI) UnmarshalJSON(b []byte) error
• type ExtendedUplinkResponse
  • func (r ExtendedUplinkResponse) MarshalJSON() ([]byte, error)
  • func (r *ExtendedUplinkResponse) UnmarshalJSON(b []byte) error
• type Hex
  • func (h Hex) MarshalJSON() ([]byte, error)
  • func (h Hex) String() string
  • func (h *Hex) UnmarshalJSON(b []byte) (err error)
• type LoRaDnlink
  • func (u LoRaDnlink) Fields() map[string]interface{}
• type LoRaUplink
• type LoRaUplinkType
  • func (t LoRaUplinkType) MarshalJSON() ([]byte, error)
  • func (t *LoRaUplinkType) UnmarshalJSON(b []byte) error
• type PositionSolution
• type PositionSolutionType
  • func (t PositionSolutionType) MarshalJSON() ([]byte, error)
  • func (t PositionSolutionType) String() string
  • func (t *PositionSolutionType) UnmarshalJSON(b []byte) error
• type StreamRecord
  • func (r StreamRecord) MarshalJSON() ([]byte, error)
  • func (r *StreamRecord) UnmarshalJSON(b []byte) error
• type UplinkResponse

Types

type DeviceUplinkResponse

type DeviceUplinkResponse struct {
	Result ExtendedUplinkResponse `json:"result"`
	Error  string                 `json:"error"`
}

DeviceUplinkResponse contains the uplink response and the error if applicable.

type DeviceUplinkResponses

type DeviceUplinkResponses map[EUI]DeviceUplinkResponse

DeviceUplinkResponses maps the device EUIs to the DeviceUplinkResponse.

func (DeviceUplinkResponses) UnmarshalJSON

func (d DeviceUplinkResponses) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type DeviceUplinks

type DeviceUplinks map[EUI]*LoRaUplink

DeviceUplinks maps device EUIs to LoRaUplink

func (DeviceUplinks) MarshalJSON

func (u DeviceUplinks) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

type EUI

type EUI types.EUI64

EUI represents a dash-separated EUI64.

func (EUI) MarshalJSON

func (e EUI) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (EUI) String

func (e EUI) String() string

func (*EUI) UnmarshalJSON

func (e *EUI) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

type ExtendedUplinkResponse

type ExtendedUplinkResponse struct {
	UplinkResponse

	Raw *json.RawMessage
}

ExtendedUplinkResponse extends UplinkResponse with the raw JSON payload.

func (ExtendedUplinkResponse) MarshalJSON

func (r ExtendedUplinkResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler. Note that the Raw representation takes precedence in the marshaling process, if it is available.

func (*ExtendedUplinkResponse) UnmarshalJSON

func (r *ExtendedUplinkResponse) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Marshaler.

type Hex

type Hex []byte

Hex represents hex encoded bytes.

func (Hex) MarshalJSON

func (h Hex) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (Hex) String

func (h Hex) String() string

String implements fmt.Stringer.

func (*Hex) UnmarshalJSON

func (h *Hex) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implements json.Unmarshaler.

type LoRaDnlink

type LoRaDnlink struct {
	Port    uint8 `json:"port"`
	Payload Hex   `json:"payload"`
}

LoRaDnlink is a specification for a modem device.

func (LoRaDnlink) Fields

func (u LoRaDnlink) Fields() map[string]interface{}

Fields implements log.Fielder.

type LoRaUplink

type LoRaUplink struct {
	Type LoRaUplinkType `json:"msgtype"`

	FCnt        *uint32  `json:"fcnt,omitempty"`
	Port        *uint8   `json:"port,omitempty"`
	Payload     *Hex     `json:"payload,omitempty"`
	DR          *uint8   `json:"dr,omitempty"`
	Freq        *uint32  `json:"freq,omitempty"`
	Timestamp   *float64 `json:"timestamp,omitempty"`
	DownlinkMTU *uint32  `json:"dn_mtu,omitempty"`

	GNSSCaptureTime         *float64  `json:"gnss_capture_time,omitempty"`
	GNSSCaptureTimeAccuracy *float64  `json:"gnss_capture_time_accuracy,omitempty"`
	GNSSAssistPosition      []float64 `json:"gnss_assist_position,omitempty"`
	GNSSAssistAltitude      *float64  `json:"gnss_assist_altitude,omitempty"`
	GNSSUse2DSolver         *bool     `json:"gnss_use_2D_solver,omitempty"`
}

LoRaUplink encapsulates the information of a LoRa message.

type LoRaUplinkType

type LoRaUplinkType uint8

LoRaUplinkType is the type of a LoRaCloud DMS uplink.

const (
	// UplinkUplinkType is LoRaWAN Message Type.
	UplinkUplinkType LoRaUplinkType = iota
	// ModemUplinkType is DMS Protocol Message Type.
	ModemUplinkType
	// JoiningUplinkType is Session Reset Message Type.
	JoiningUplinkType
	// GNSSUplinkType is DMS GNSS Message Type.
	GNSSUplinkType
	// WiFiUplinkType is DMS WiFi Message Type.
	WiFiUplinkType
	// UnknownUplinkType is used when the uplink type is unknown.
	UnknownUplinkType
)

func (LoRaUplinkType) MarshalJSON

func (t LoRaUplinkType) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*LoRaUplinkType) UnmarshalJSON

func (t *LoRaUplinkType) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the json.Unarmshaler.

type PositionSolution

type PositionSolution struct {
	Algorithm PositionSolutionType `json:"algorithm_type"`
	LLH       []float64            `json:"llh"`
	Accuracy  float64              `json:"accuracy"`
}

PositionSolution is the result of a position query.

type PositionSolutionType

type PositionSolutionType uint8

PositionSolutionType is the algorithm used by a position solution query.

const (
	// GNSSPositionSolutionType is GNSS position solution type.
	GNSSPositionSolutionType PositionSolutionType = iota
	// WiFiPositionSolutionType is WiFi position solution type.
	WiFiPositionSolutionType
	// UnknownPositionSolutionType is used when the position solution type is unknown.
	UnknownPositionSolutionType
)

func (PositionSolutionType) MarshalJSON

func (t PositionSolutionType) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (PositionSolutionType) String

func (t PositionSolutionType) String() string

String implements fmt.Stringer.

func (*PositionSolutionType) UnmarshalJSON

func (t *PositionSolutionType) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the json.Unarmshaler.

type StreamRecord

type StreamRecord struct {
	Offset uint32
	Data   Hex
}

StreamRecord contains the offset and the data of a fully reconstructed stream frame.

func (StreamRecord) MarshalJSON

func (r StreamRecord) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (*StreamRecord) UnmarshalJSON

func (r *StreamRecord) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Marshaler.

type UplinkResponse

type UplinkResponse struct {
	Downlink      *LoRaDnlink       `json:"dnlink"`
	StreamRecords []StreamRecord    `json:"stream_records"`
	Position      *PositionSolution `json:"position_solution"`
}

UplinkResponse contains the state changes and completed items due to an uplink message.