models

Documentation

Index

• type CreateDeviceTypeAttribute
• type DeviceIntegration
• type DeviceMake
• type DeviceStyle
• type DeviceType
• type DeviceTypeAttribute
• type GetDeviceDefinitionQueryResult
• type GetDeviceStyleQueryResult
• type GetDeviceTypeAttributeQueryResult
• type GetDeviceTypeQueryResult
• type GetIntegrationQueryResult
• type IntegrationsMetadata
• type PowertrainType
  • func (p PowertrainType) String() string
  • func (p *PowertrainType) UnmarshalJSON(b []byte) error
• type UpdateDeviceTypeAttribute
• type VehicleInfo

Types

type CreateDeviceTypeAttribute

type CreateDeviceTypeAttribute struct {
	Name         string   `json:"name"`
	Label        string   `json:"label"`
	Description  string   `json:"description"`
	Type         string   `json:"type"`
	Required     bool     `json:"required"`
	DefaultValue string   `json:"default_value"`
	Option       []string `json:"options"`
}

type DeviceIntegration

type DeviceIntegration struct {
	ID           string          `json:"id"`
	Type         string          `json:"type"`
	Style        string          `json:"style"`
	Vendor       string          `json:"vendor"`
	Region       string          `json:"region"`
	Capabilities json.RawMessage `json:"capabilities"`
}

type DeviceMake

type DeviceMake struct {
	ID              string          `json:"id"`
	Name            string          `json:"name"`
	LogoURL         null.String     `json:"logo_url"`
	OemPlatformName null.String     `json:"oem_platform_name"`
	TokenID         *big.Int        `json:"tokenId,omitempty"`
	NameSlug        string          `json:"nameSlug"`
	ExternalIds     json.RawMessage `json:"external_ids"`
}

type DeviceStyle

type DeviceStyle struct {
	ID                 string `json:"id"`
	DeviceDefinitionID string `json:"deviceDefinitionId"`
	Name               string `json:"name"`
	ExternalStyleID    string `json:"externalStyleId"`
	Source             string `json:"source"`
	SubModel           string `json:"subModel"`
}

type DeviceType

type DeviceType struct {
	// Type is eg. Vehicle, E-bike, roomba
	Type      string   `json:"type"`
	Make      string   `json:"make"`
	Model     string   `json:"model"`
	Year      int      `json:"year"`
	SubModels []string `json:"subModels"`
	MakeSlug  string   `json:"makeSlug"`
	ModelSlug string   `json:"modelSlug"`
}

DeviceType whether it is a vehicle or other type and basic information

type DeviceTypeAttribute

type DeviceTypeAttribute struct {
	Name        string   `json:"name"`
	Label       string   `json:"label"`
	Description string   `json:"description"`
	Type        string   `json:"type"`
	Required    bool     `json:"required"`
	Value       string   `json:"value"`
	Option      []string `json:"options"`
}

type GetDeviceDefinitionQueryResult

type GetDeviceDefinitionQueryResult struct {
	DeviceDefinitionID string      `json:"deviceDefinitionId"`
	ExternalID         string      `json:"external_id"`
	Name               string      `json:"name"`
	ImageURL           string      `json:"imageUrl"`
	Source             string      `json:"source"`
	DeviceMake         DeviceMake  `json:"make"`
	Type               DeviceType  `json:"type"`
	VehicleInfo        VehicleInfo `json:"vehicleData,omitempty"`
	Metadata           interface{} `json:"metadata"`
	Verified           bool        `json:"verified"`
	// DeviceIntegrations has integrations this vehicle can integrate with, from table device_integrations
	DeviceIntegrations     []DeviceIntegration   `json:"deviceIntegrations"`
	CompatibleIntegrations []DeviceIntegration   `json:"compatibleIntegrations"`
	DeviceStyles           []DeviceStyle         `json:"deviceStyles"`
	DeviceAttributes       []DeviceTypeAttribute `json:"deviceAttributes"`
}

type GetDeviceStyleQueryResult

type GetDeviceStyleQueryResult struct {
	ID                 string `json:"id"`
	DeviceDefinitionID string `json:"device_definition_id"`
	Name               string `json:"name"`
	ExternalStyleID    string `json:"external_style_id"`
	Source             string `json:"source"`
	SubModel           string `json:"sub_model"`
}

type GetDeviceTypeAttributeQueryResult

type GetDeviceTypeAttributeQueryResult struct {
	Name         string   `json:"name"`
	Label        string   `json:"label"`
	Description  string   `json:"description"`
	Type         string   `json:"type"`
	Required     bool     `json:"required"`
	DefaultValue string   `json:"default_value"`
	Option       []string `json:"options"`
}

type GetDeviceTypeQueryResult

type GetDeviceTypeQueryResult struct {
	ID          string                              `json:"id"`
	Name        string                              `json:"name"`
	Metadatakey string                              `json:"metadata_key"`
	Attributes  []GetDeviceTypeAttributeQueryResult `json:"attributes"`
}

type GetIntegrationQueryResult

type GetIntegrationQueryResult struct {
	ID                           string                 `json:"id"`
	Type                         string                 `json:"type"`
	Style                        string                 `json:"style"`
	Vendor                       string                 `json:"vendor"`
	AutoPiDefaultTemplateID      int                    `json:"auto_pi_default_template_id"`
	RefreshLimitSecs             int                    `json:"refresh_limit_secs"`
	AutoPiPowertrainToTemplateID map[PowertrainType]int `json:"auto_pi_power_train_to_template_id,omitempty"`
}

type IntegrationsMetadata

type IntegrationsMetadata struct {
	AutoPiDefaultTemplateID      int                    `json:"autoPiDefaultTemplateId"`
	AutoPiPowertrainToTemplateID map[PowertrainType]int `json:"autoPiPowertrainToTemplateId,omitempty"`
}

IntegrationsMetadata represents json stored in integrations table metadata jsonb column

type PowertrainType

type PowertrainType string

const (
	ICE  PowertrainType = "ICE"
	HEV  PowertrainType = "HEV"
	PHEV PowertrainType = "PHEV"
	BEV  PowertrainType = "BEV"
	FCEV PowertrainType = "FCEV"
)

func (PowertrainType) String

func (p PowertrainType) String() string

func (*PowertrainType) UnmarshalJSON

func (p *PowertrainType) UnmarshalJSON(b []byte) error

type UpdateDeviceTypeAttribute

type UpdateDeviceTypeAttribute struct {
	// Name should match one of the name keys in the allowed device_types.properties
	Name  string `json:"name"`
	Value string `json:"value"`
}

type VehicleInfo

type VehicleInfo struct {
	FuelType            string `json:"fuel_type,omitempty"`
	DrivenWheels        string `json:"driven_wheels,omitempty"`
	NumberOfDoors       string `json:"number_of_doors,omitempty"`
	BaseMSRP            int    `json:"base_msrp,omitempty"`
	EPAClass            string `json:"epa_class,omitempty"`
	VehicleType         string `json:"vehicle_type,omitempty"` // VehicleType PASSENGER CAR, from NHTSA
	MPGHighway          string `json:"mpg_highway,omitempty"`
	MPGCity             string `json:"mpg_city,omitempty"`
	FuelTankCapacityGal string `json:"fuel_tank_capacity_gal,omitempty"`
	MPG                 string `json:"mpg,omitempty"`
}

VehicleInfo represents some standard vehicle specific properties stored in the metadata json field in DB