data

package
v0.0.6 Latest Latest
Warning

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

 Go to latest Published: Jun 26, 2020 License: Apache-2.0 Imports: 3 Imported by: 10

Documentation

Overview

Package data specifies data structures that are used on the wire.

Index

Constants

View Source 
const (
	SysStateUnknown  SysState = 0
	SysStatePowerOff          = 1
	SysStateOffline           = 2
	SysStateOnline            = 3
)

define valid system states don't even think about changing the below as it used in communications -- add new numbers if something needs changed/added.

View Source 
const (
	CmdUpdateApp string = "updateApp"
	CmdPoll             = "poll"
	CmdFieldMode        = "fieldMode"
)

define valid commands

View Source 
const (
	SampleTypeStartApp    string = "startApp"
	SampleTypeStartSystem        = "startSystem"
	SampleTypeUpdateOS           = "updateOS"
	SampleTypeUpdateApp          = "updateApp"
	SampleTypeSysState           = "sysState"
)

define common sample types

Variables

This section is empty.

Functions

This section is empty.

Types

type Auth added in v0.0.5 

type Auth struct {
	Token  string `json:"token"`
	IsRoot bool   `json:"isRoot"`
}

Auth is an authentication response.

type Config added in v0.0.5 

type Config struct {
	NAME  string `json:"id"`
	IO    string
	Value float64 `json:"value"`
}

Config defines parameter of config

type Data added in v0.0.5 

type Data struct {
	Groups  []Group  `json:"groups"`
	Users   []User   `json:"users"`
	Devices []Device `json:"devices"`
}

Data provides all application data.

type Device 

type Device struct {
	ID         string       `json:"id" boltholdKey:"ID"`
	Config     DeviceConfig `json:"config"`
	State      DeviceState  `json:"state"`
	CmdPending bool         `json:"cmdPending"`
	Groups     []uuid.UUID  `json:"groups"`
}

Device represents the state of a device The config is typically updated by the portal/UI, and the State is updated by the device. Keeping these datastructures separate reduces the possibility that one update will step on another.

func (*Device) ProcessSample 

func (d *Device) ProcessSample(sample Sample)

ProcessSample takes a sample for a device and adds/updates in Ios

func (*Device) UpdateState added in v0.0.6 

func (d *Device) UpdateState() bool

UpdateState does routine updates of state (offline status, etc). Returns true if state was updated.

type DeviceCmd 

type DeviceCmd struct {
	ID     string `json:"id,omitempty" boltholdKey:"ID"`
	Cmd    string `json:"cmd"`
	Detail string `json:"detail,omitempty"`
}

DeviceCmd represents a command to be sent to a device

type DeviceConfig 

type DeviceConfig struct {
	Description string `json:"description"`
}

DeviceConfig represents a device configuration (stuff that is set by user in UI)

type DeviceState 

type DeviceState struct {
	Version  DeviceVersion `json:"version"`
	Ios      []Sample      `json:"ios"`
	LastComm time.Time     `json:"lastComm"`
	SysState SysState      `json:"sysState"`
}

DeviceState represents information about a device that is collected, vs set by user.

type DeviceVersion 

type DeviceVersion struct {
	OS  string `json:"os"`
	App string `json:"app"`
	HW  string `json:"hw"`
}

DeviceVersion represents the device SW version

type Event 

type Event struct {
	Time    time.Time
	Type    EventType
	Level   EventLevel
	Message string
}

Event describes something that happened and might be displayed to user in a a sequential log format.

type EventLevel 

type EventLevel int

EventLevel is used to describe the "severity" of the event and can be used to quickly filter the type of events 

const (
	EventLevelFault EventLevel = 3
	EventLevelInfo
	EventLevelDebug
)

define valid events

type EventType 

type EventType int

EventType describes an event. Custom applications that build on top of Simple IoT should custom event types at high number above 10,000 to ensure there is not a collision between type IDs. Note, these enums should never change. 

const (
	EventTypeStartSystem EventType = 10
	EventTypeStartApp
	EventTypeSystemUpdate
	EventTypeAppUpdate
)

define valid events

type GpsPos 

type GpsPos struct {
	Lat    float64 `json:"lat"`
	Long   float64 `json:"long"`
	Fix    string  `json:"fix"`
	NumSat int64   `json:"numSat"`
}

GpsPos describes location and fix information from a GPS

func (*GpsPos) FromGPGGA 

func (p *GpsPos) FromGPGGA(gpgga nmea.GPGGA)

FromGPGGA converts a GPGGA string to a position/fix

type Group added in v0.0.5 

type Group struct {
	ID     uuid.UUID   `json:"id" boltholdKey:"ID"`
	Name   string      `json:"name"`
	Parent uuid.UUID   `json:"parent"`
	Users  []UserRoles `json:"users"`
}

An Group represents a named collection of Users and Devices.

func (*Group) FindUsers added in v0.0.5 

func (o *Group) FindUsers(role Role) []uuid.UUID

FindUsers returns users for specified role

type Role added in v0.0.5 

type Role string

Role of user 

const (
	RoleAdmin Role = "admin"
	RoleUser       = "user"
)

define standard roles

type Sample 

type Sample struct {
	// Type of sample (voltage, current, key, etc)
	Type string `json:"type,omitempty" boltholdIndex:"Type" influx:"type,tag"`

	// ID of the device that provided the sample
	ID string `json:"id,omitempty" influx:"id,tag"`

	// Average OR
	// Instantaneous analog or digital value of the sample.
	// 0 and 1 are used to represent digital values
	Value float64 `json:"value,omitempty" influx:"value"`

	// statistical values that may be calculated
	Min float64 `json:"min,omitempty" influx:"min"`
	Max float64 `json:"max,omitempty" influx:"max"`

	// Time the sample was taken
	Time time.Time `json:"time,omitempty" boltholdKey:"Time" gob:"-" influx:"time"`

	// Duration over which the sample was taken
	Duration time.Duration `json:"duration,omitempty" influx:"duration"`

	// Tags are additional attributes used to describe the sample
	// You might add things like friendly name, etc.
	Tags map[string]string `json:"tags,omitempty" influx:"-"`

	// Attributes are additional numerical values
	Attributes map[string]float64 `json:"attributes,omitempty" influx:"-"`
}

Sample represents a value in time and should include data that may be graphed.

func (*Sample) Bool 

func (s *Sample) Bool() bool

Bool returns a bool representation of value

func (Sample) ForDevice added in v0.0.6 

func (s Sample) ForDevice() bool

ForDevice tells us if a sample is for device (vs IO)

type SampleAverager 

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

SampleAverager accumulates samples, and averages them. The average can be reset.

func NewSampleAverager 

func NewSampleAverager(sampleType string) *SampleAverager

NewSampleAverager initializes and returns an averager

func (*SampleAverager) AddSample 

func (sa *SampleAverager) AddSample(s Sample)

AddSample takes a sample, and adds it to the total

func (*SampleAverager) GetAverage 

func (sa *SampleAverager) GetAverage() Sample

GetAverage returns the average of the accumulated samples

func (*SampleAverager) ResetAverage 

func (sa *SampleAverager) ResetAverage()

ResetAverage sets the accumulated total to zero

type StandardResponse 

type StandardResponse struct {
	Success bool   `json:"success"`
	Error   string `json:"error,omitempty"`
	ID      string `json:"id,omitempty"`
}

StandardResponse is the standard response to any request

type SysState added in v0.0.6 

type SysState int

SysState defines the system state

type TimeWindowAverager 

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

TimeWindowAverager accumulates samples, and averages them on a fixed time period and outputs the average/min/max, etc as a sample

func NewTimeWindowAverager 

func NewTimeWindowAverager(windowLen time.Duration, callBack func(Sample), sampleType string) *TimeWindowAverager

NewTimeWindowAverager initializes and returns an averager

func (*TimeWindowAverager) NewSample 

func (twa *TimeWindowAverager) NewSample(s Sample)

NewSample takes a sample, and if the time window expired, it calls the callback function with the a new sample which is avg of all samples since start time.

type User 

type User struct {
	ID        uuid.UUID `json:"id" boltholdKey:"ID"`
	FirstName string    `json:"firstName"`
	LastName  string    `json:"lastName"`
	Email     string    `json:"email"`
	Pass      string    `json:"pass"`
}

User represents a user of the system

type UserRoles added in v0.0.5 

type UserRoles struct {
	UserID uuid.UUID `json:"userId"`
	Roles  []Role    `json:"roles"`
}

UserRoles describes a users roles in a group

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.