fkdevice

package module

v0.0.0-...-4af77be Latest Latest Go to latest Published: Aug 1, 2023 License: BSD-3-Clause Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/fieldkit/fkc

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Decode(ctx context.Context, decode DecodeFunction) error
func DecodeApp(ctx context.Context, b []byte) error
func DecodeData(ctx context.Context, b []byte) error
func DecodeModuleConfig(ctx context.Context, b []byte) error
type DeadlineReader
- func (dr *DeadlineReader) Read(p []byte) (n int, err error)
type DebugReader
- func (dr *DebugReader) Read(p []byte) (n int, err error)
type DecodeFunction
type DeviceClient
- func (d *DeviceClient) ClearLora() (*pb.HttpReply, error)
- func (d *DeviceClient) ConfigureLoraAbp(appSessionKey, networkSessionKey, deviceAddress string, ...) (*pb.HttpReply, error)
- func (d *DeviceClient) ConfigureLoraOtaa(deviceEui, appKey, joinEui string, frequencyBand int) (*pb.HttpReply, error)
- func (d *DeviceClient) ConfigureName(name string) (*pb.HttpReply, error)
- func (d *DeviceClient) ConfigureSchedule(readings, network, gps, lora uint32) (*pb.HttpReply, error)
- func (d *DeviceClient) ConfigureTransmission(url, token string) (*pb.HttpReply, error)
- func (d *DeviceClient) ConfigureWifiNetworks(networks []*pb.NetworkInfo) (*pb.HttpReply, error)
- func (d *DeviceClient) FactoryReset() (*pb.HttpReply, error)
- func (d *DeviceClient) ModuleQuery(bay uint32, query []byte) ([]byte, error)
- func (d *DeviceClient) QueryGetReadings() (*pb.HttpReply, error)
- func (d *DeviceClient) QueryListing(path string, page uint32) (*pb.HttpReply, error)
- func (d *DeviceClient) QueryScanModules() (*pb.HttpReply, error)
- func (d *DeviceClient) QueryScanNetworks() (*pb.HttpReply, error)
- func (d *DeviceClient) QueryStartRecording() (*pb.HttpReply, error)
- func (d *DeviceClient) QueryStatus() (*pb.HttpReply, error)
- func (d *DeviceClient) QueryStopRecording() (*pb.HttpReply, error)
- func (d *DeviceClient) QueryTakeReadings() (*pb.HttpReply, error)
type DeviceClientLoggingCallbacks
type DeviceQueryOpts
type LimitedReader
- func (dr *LimitedReader) Read(p []byte) (n int, err error)
type LogJsonCallbacks
- func (cb *LogJsonCallbacks) Received(reply *pb.HttpReply)
- func (cb *LogJsonCallbacks) Sent(query *pb.HttpQuery)
type QueryResponse
- func (qr *QueryResponse) Close() error
- func (qr *QueryResponse) Reader(to int) io.Reader

Constants ¶

View Source

const (
	DefaultTimeout = 5
)

Variables ¶

View Source

var DeviceBusyErr = fmt.Errorf("Busy")

Functions ¶

func Decode ¶

func Decode(ctx context.Context, decode DecodeFunction) error

func DecodeApp ¶

func DecodeApp(ctx context.Context, b []byte) error

func DecodeData ¶

func DecodeData(ctx context.Context, b []byte) error

func DecodeModuleConfig ¶

func DecodeModuleConfig(ctx context.Context, b []byte) error

Types ¶

type DeadlineReader ¶

type DeadlineReader struct {
	Target  net.Conn
	Timeout time.Duration
}

func (*DeadlineReader) Read ¶

func (dr *DeadlineReader) Read(p []byte) (n int, err error)

type DebugReader ¶

type DebugReader struct {
	Target io.Reader
}

func (*DebugReader) Read ¶

func (dr *DebugReader) Read(p []byte) (n int, err error)

type DecodeFunction ¶

type DecodeFunction func(ctx context.Context, b []byte) error

type DeviceClient ¶

type DeviceClient struct {
	Callbacks DeviceClientLoggingCallbacks
	Address   string
	HexEncode bool
	Port      int
}

func (*DeviceClient) ClearLora ¶

func (d *DeviceClient) ClearLora() (*pb.HttpReply, error)

func (*DeviceClient) ConfigureLoraAbp ¶

func (d *DeviceClient) ConfigureLoraAbp(appSessionKey, networkSessionKey, deviceAddress string, uplinkCounter, downlinkCounter, frequencyBand uint32) (*pb.HttpReply, error)

func (*DeviceClient) ConfigureLoraOtaa ¶

func (d *DeviceClient) ConfigureLoraOtaa(deviceEui, appKey, joinEui string, frequencyBand int) (*pb.HttpReply, error)

func (*DeviceClient) ConfigureName ¶

func (d *DeviceClient) ConfigureName(name string) (*pb.HttpReply, error)

func (*DeviceClient) ConfigureSchedule ¶

func (d *DeviceClient) ConfigureSchedule(readings, network, gps, lora uint32) (*pb.HttpReply, error)

func (*DeviceClient) ConfigureTransmission ¶

func (d *DeviceClient) ConfigureTransmission(url, token string) (*pb.HttpReply, error)

func (*DeviceClient) ConfigureWifiNetworks ¶

func (d *DeviceClient) ConfigureWifiNetworks(networks []*pb.NetworkInfo) (*pb.HttpReply, error)

func (*DeviceClient) FactoryReset ¶

func (d *DeviceClient) FactoryReset() (*pb.HttpReply, error)

func (*DeviceClient) ModuleQuery ¶

func (d *DeviceClient) ModuleQuery(bay uint32, query []byte) ([]byte, error)

func (*DeviceClient) QueryGetReadings ¶

func (d *DeviceClient) QueryGetReadings() (*pb.HttpReply, error)

func (*DeviceClient) QueryListing ¶

func (d *DeviceClient) QueryListing(path string, page uint32) (*pb.HttpReply, error)

func (*DeviceClient) QueryScanModules ¶

func (d *DeviceClient) QueryScanModules() (*pb.HttpReply, error)

func (*DeviceClient) QueryScanNetworks ¶

func (d *DeviceClient) QueryScanNetworks() (*pb.HttpReply, error)

func (*DeviceClient) QueryStartRecording ¶

func (d *DeviceClient) QueryStartRecording() (*pb.HttpReply, error)

func (*DeviceClient) QueryStatus ¶

func (d *DeviceClient) QueryStatus() (*pb.HttpReply, error)

func (*DeviceClient) QueryStopRecording ¶

func (d *DeviceClient) QueryStopRecording() (*pb.HttpReply, error)

func (*DeviceClient) QueryTakeReadings ¶

func (d *DeviceClient) QueryTakeReadings() (*pb.HttpReply, error)

type DeviceClientLoggingCallbacks ¶

type DeviceClientLoggingCallbacks interface {
	Sent(query *pb.HttpQuery)
	Received(reply *pb.HttpReply)
}

type DeviceQueryOpts ¶

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

type LimitedReader ¶

type LimitedReader struct {
	Target           io.Reader
	MessagesExpected int
}

func (*LimitedReader) Read ¶

func (dr *LimitedReader) Read(p []byte) (n int, err error)

type LogJsonCallbacks ¶

type LogJsonCallbacks struct {
	Save string
}

func (*LogJsonCallbacks) Received ¶

func (cb *LogJsonCallbacks) Received(reply *pb.HttpReply)

func (*LogJsonCallbacks) Sent ¶

func (cb *LogJsonCallbacks) Sent(query *pb.HttpQuery)

type QueryResponse ¶

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

func (*QueryResponse) Close ¶

func (qr *QueryResponse) Close() error

func (*QueryResponse) Reader ¶

func (qr *QueryResponse) Reader(to int) io.Reader

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd

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