types

package
v2.0.0 Latest Latest
Warning

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

 Go to latest Published: Jun 18, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ExecutionStatusSuccess    = "SUCCESS"
	ExecutionStatusPending    = "PENDING"
	ExecutionStatusOffline    = "OFFLINE"
	ExecutionStatusExceptions = "EXCEPTIONS"
	ExecutionStatusError      = "ERROR"
)

Execution status

View Source 
const (
	StatusSuccess    = "SUCCESS"
	StatusOffline    = "OFFLINE"
	StatusExceptions = "EXCEPTIONS"
	StatusError      = "ERROR"
)
View Source 
const (
	IntentSync       = "action.devices.SYNC"
	IntentQuery      = "action.devices.QUERY"
	IntentExecute    = "action.devices.EXECUTE"
	IntentDisconnect = "action.devices.DISCONNECT"
)

Intent types

Variables

View Source 
var (
	// https://developers.google.com/assistant/smarthome/guides
	DeviceMap = map[string]string{
		vdTY.DeviceTypeAirConditioner:         "action.devices.types.AC_UNIT",
		vdTY.DeviceTypeAirCooler:              "action.devices.types.AIRCOOLER",
		vdTY.DeviceTypeAirFreshener:           "action.devices.types.AIRFRESHENER",
		vdTY.DeviceTypeAirPurifier:            "action.devices.types.AIRPURIFIER",
		vdTY.DeviceTypeAudioVideoReceiver:     "action.devices.types.AUDIO_VIDEO_RECEIVER",
		vdTY.DeviceTypeAwning:                 "action.devices.types.AWNING",
		vdTY.DeviceTypeBathtub:                "action.devices.types.BATHTUB",
		vdTY.DeviceTypeBed:                    "action.devices.types.BED",
		vdTY.DeviceTypeBlinds:                 "action.devices.types.BLENDER",
		vdTY.DeviceTypeBlender:                "action.devices.types.BLINDS",
		vdTY.DeviceTypeBoiler:                 "action.devices.types.BOILER",
		vdTY.DeviceTypeCamera:                 "action.devices.types.CAMERA",
		vdTY.DeviceTypeCarbonMonoxideDetector: "action.devices.types.CARBON_MONOXIDE_DETECTOR",
		vdTY.DeviceTypeCharger:                "action.devices.types.CHARGER",
		vdTY.DeviceTypeCloset:                 "action.devices.types.CLOSET",
		vdTY.DeviceTypeCoffeeMaker:            "action.devices.types.COFFEE_MAKER",
		vdTY.DeviceTypeCooktop:                "action.devices.types.COOKTOP",
		vdTY.DeviceTypeCurtain:                "action.devices.types.CURTAIN",
		vdTY.DeviceTypeDehumidifier:           "action.devices.types.DEHUMIDIFIER",
		vdTY.DeviceTypeDehydrator:             "action.devices.types.DEHYDRATOR",
		vdTY.DeviceTypeDishwasher:             "action.devices.types.DISHWASHER",
		vdTY.DeviceTypeDoor:                   "action.devices.types.DOOR",
		vdTY.DeviceTypeDoorBell:               "action.devices.types.DOORBELL",
		vdTY.DeviceTypeDrawer:                 "action.devices.types.DRAWER",
		vdTY.DeviceTypeDryer:                  "action.devices.types.DRYER",
		vdTY.DeviceTypeFan:                    "action.devices.types.FAN",
		vdTY.DeviceTypeFaucet:                 "action.devices.types.FAUCET",
		vdTY.DeviceTypeFireplace:              "action.devices.types.FIREPLACE",
		vdTY.DeviceTypeFreezer:                "action.devices.types.FREEZER",
		vdTY.DeviceTypeFryer:                  "action.devices.types.FRYER",
		vdTY.DeviceTypeGarageDoor:             "action.devices.types.GARAGE",
		vdTY.DeviceTypeGate:                   "action.devices.types.GATE",
		vdTY.DeviceTypeGrill:                  "action.devices.types.GRILL",
		vdTY.DeviceTypeHeater:                 "action.devices.types.HEATER",
		vdTY.DeviceTypeHood:                   "action.devices.types.HOOD",
		vdTY.DeviceTypeHumidifier:             "action.devices.types.HUMIDIFIER",
		vdTY.DeviceTypeKettle:                 "action.devices.types.KETTLE",
		vdTY.DeviceTypeLight:                  "action.devices.types.LIGHT",
		vdTY.DeviceTypeLock:                   "action.devices.types.LOCK",
		vdTY.DeviceTypeMicrowave:              "action.devices.types.MICROWAVE",
		vdTY.DeviceTypeMop:                    "action.devices.types.MOP",
		vdTY.DeviceTypeMower:                  "action.devices.types.MOWER",
		vdTY.DeviceTypeMulticooker:            "action.devices.types.MULTICOOKER",
		vdTY.DeviceTypeNetwork:                "action.devices.types.NETWORK",
		vdTY.DeviceTypeOutlet:                 "action.devices.types.OUTLET",
		vdTY.DeviceTypeOven:                   "action.devices.types.OVEN",
		vdTY.DeviceTypePergola:                "action.devices.types.PERGOLA",
		vdTY.DeviceTypePetFeeder:              "action.devices.types.PETFEEDER",
		vdTY.DeviceTypePressureCooker:         "action.devices.types.PRESSURECOOKER",
		vdTY.DeviceTypeRadiator:               "action.devices.types.RADIATOR",
		vdTY.DeviceTypeRefrigerator:           "action.devices.types.REFRIGERATOR",
		vdTY.DeviceTypeRemoteControl:          "action.devices.types.REMOTECONTROL",
		vdTY.DeviceTypeRouter:                 "action.devices.types.ROUTER",
		vdTY.DeviceTypeScene:                  "action.devices.types.SCENE",
		vdTY.DeviceTypeSecuritySystem:         "action.devices.types.SECURITYSYSTEM",
		vdTY.DeviceTypeSensor:                 "action.devices.types.SENSOR",
		vdTY.DeviceTypeSetTopBox:              "action.devices.types.SETTOP",
		vdTY.DeviceTypeShower:                 "action.devices.types.SHOWER",
		vdTY.DeviceTypeShutter:                "action.devices.types.SHUTTER",
		vdTY.DeviceTypeSmokeDetector:          "action.devices.types.SMOKE_DETECTOR",
		vdTY.DeviceTypeSoundbar:               "action.devices.types.SOUNDBAR",
		vdTY.DeviceTypeSousVide:               "action.devices.types.SOUSVIDE",
		vdTY.DeviceTypeSpeaker:                "action.devices.types.SPEAKER",
		vdTY.DeviceTypeSprinkler:              "action.devices.types.SPRINKLER",
		vdTY.DeviceTypeStandMixer:             "action.devices.types.STANDMIXER",
		vdTY.DeviceTypeStreamingBox:           "action.devices.types.STREAMING_BOX",
		vdTY.DeviceTypeStreamingSoundbar:      "action.devices.types.STREAMING_SOUNDBAR",
		vdTY.DeviceTypeStreamingStick:         "action.devices.types.STREAMING_STICK",
		vdTY.DeviceTypeSwitch:                 "action.devices.types.SWITCH",
		vdTY.DeviceTypeThermostat:             "action.devices.types.THERMOSTAT",
		vdTY.DeviceTypeTelevision:             "action.devices.types.TV",
		vdTY.DeviceTypeVacuum:                 "action.devices.types.VACUUM",
		vdTY.DeviceTypeValve:                  "action.devices.types.VALVE",
		vdTY.DeviceTypeWasher:                 "action.devices.types.WASHER",
		vdTY.DeviceTypeWaterHeater:            "action.devices.types.WATERHEATER",
		vdTY.DeviceTypeWaterPurifier:          "action.devices.types.WATERPURIFIER",
		vdTY.DeviceTypeWaterSoftener:          "action.devices.types.WATERSOFTENER",
		vdTY.DeviceTypeWeatherStation:         "action.devices.types.SENSOR",
		vdTY.DeviceTypeWindow:                 "action.devices.types.WINDOW",
		vdTY.DeviceTypeYogurtMaker:            "action.devices.types.YOGURTMAKER",
	}

	// https://developers.google.com/assistant/smarthome/traits
	TraitMap = map[string]string{
		vdTY.DeviceTraitAppSelector:        "action.devices.traits.AppSelector",
		vdTY.DeviceTraitArmDisarm:          "action.devices.traits.ArmDisarm",
		vdTY.DeviceTraitBrightness:         "action.devices.traits.Brightness",
		vdTY.DeviceTraitCameraStream:       "action.devices.traits.CameraStream",
		vdTY.DeviceTraitChannel:            "action.devices.traits.Channel",
		vdTY.DeviceTraitColorSetting:       "action.devices.traits.ColorSetting",
		vdTY.DeviceTraitCook:               "action.devices.traits.Cook",
		vdTY.DeviceTraitDispense:           "action.devices.traits.Dispense",
		vdTY.DeviceTraitDock:               "action.devices.traits.Dock",
		vdTY.DeviceTraitEnergyStorage:      "action.devices.traits.EnergyStorage",
		vdTY.DeviceTraitFanSpeed:           "action.devices.traits.FanSpeed",
		vdTY.DeviceTraitFill:               "action.devices.traits.Fill",
		vdTY.DeviceTraitHumiditySetting:    "action.devices.traits.HumiditySetting",
		vdTY.DeviceTraitInputSelector:      "action.devices.traits.InputSelector",
		vdTY.DeviceTraitLightEffects:       "action.devices.traits.LightEffects",
		vdTY.DeviceTraitLocator:            "action.devices.traits.Locator",
		vdTY.DeviceTraitLockUnlock:         "action.devices.traits.LockUnlock",
		vdTY.DeviceTraitMediaState:         "action.devices.traits.MediaState",
		vdTY.DeviceTraitModes:              "action.devices.traits.Modes",
		vdTY.DeviceTraitNetworkControl:     "action.devices.traits.NetworkControl",
		vdTY.DeviceTraitObjectDetection:    "action.devices.traits.ObjectDetection",
		vdTY.DeviceTraitOnOff:              "action.devices.traits.OnOff",
		vdTY.DeviceTraitOpenClose:          "action.devices.traits.OpenClose",
		vdTY.DeviceTraitReboot:             "action.devices.traits.Reboot",
		vdTY.DeviceTraitRotation:           "action.devices.traits.Rotation",
		vdTY.DeviceTraitRunCycle:           "action.devices.traits.RunCycle",
		vdTY.DeviceTraitSensorState:        "action.devices.traits.SensorState",
		vdTY.DeviceTraitScene:              "action.devices.traits.Scene",
		vdTY.DeviceTraitSoftwareUpdate:     "action.devices.traits.SoftwareUpdate",
		vdTY.DeviceTraitStartStop:          "action.devices.traits.StartStop",
		vdTY.DeviceTraitStatusReport:       "action.devices.traits.StatusReport",
		vdTY.DeviceTraitTemperatureControl: "action.devices.traits.TemperatureControl",
		vdTY.DeviceTraitTemperatureSetting: "action.devices.traits.TemperatureSetting",
		vdTY.DeviceTraitTimer:              "action.devices.traits.Timer",
		vdTY.DeviceTraitToggles:            "action.devices.traits.Toggles",
		vdTY.DeviceTraitTransportControl:   "action.devices.traits.TransportControl",
		vdTY.DeviceTraitVolume:             "action.devices.traits.Volume",
	}

	CommandParamsMap = map[string]string{
		"on":         vdTY.DeviceTraitOnOff,
		"brightness": vdTY.DeviceTraitBrightness,
	}

	IgnoreParamsList = []string{
		"online",
	}
)

Functions

This section is empty.

Types

type DeviceInfo 

type DeviceInfo struct {
	Manufacturer string `json:"manufacturer,omitempty"` // optional
	Model        string `json:"model,omitempty"`        // optional
	HwVersion    string `json:"hwVersion,omitempty"`    // optional
	SwVersion    string `json:"swVersion,omitempty"`    // optional
}

type ExecuteRequest 

type ExecuteRequest struct {
	RequestID string                `json:"requestId"` // required
	Inputs    []ExecuteRequestInput `json:"inputs"`    // required
}

ExecuteRequest struct https://developers.google.com/assistant/smarthome/reference/intent/execute#request

type ExecuteRequestCommand 

type ExecuteRequestCommand struct {
	Devices   []ExecuteRequestDevice    `json:"devices"`   // required
	Execution []ExecuteRequestExecution `json:"execution"` // required
}

type ExecuteRequestDevice 

type ExecuteRequestDevice struct {
	ID         string                 `json:"id"`                   // required
	CustomData map[string]interface{} `json:"customData,omitempty"` // optional
}

type ExecuteRequestExecution 

type ExecuteRequestExecution struct {
	Command string                 `json:"command"`          // required
	Params  map[string]interface{} `json:"params,omitempty"` // optional
}

type ExecuteRequestInput 

type ExecuteRequestInput struct {
	Intent  string                `json:"intent"`  // required
	Payload ExecuteRequestPayload `json:"payload"` // required
}

type ExecuteRequestPayload 

type ExecuteRequestPayload struct {
	Commands []ExecuteRequestCommand `json:"commands"` // required
}

type ExecuteResponse 

type ExecuteResponse struct {
	RequestID string                 `json:"requestId"` // required
	Payload   ExecuteResponsePayload `json:"payload"`   // required
}

ExecuteResponse struct https://developers.google.com/assistant/smarthome/reference/intent/execute#response

type ExecuteResponseCommand 

type ExecuteResponseCommand struct {
	IDs       []string             `json:"ids"`              // required
	Status    string               `json:"status"`           // required
	States    ExecuteResponseState `json:"states,omitempty"` // optional
	ErrorCode string               `json:"errorCode"`        // optional
}

type ExecuteResponsePayload 

type ExecuteResponsePayload struct {
	ErrorCode   string                   `json:"errorCode,omitempty"`   // optional
	DebugString string                   `json:"debugString,omitempty"` // optional
	Commands    []ExecuteResponseCommand `json:"commands"`              // required
}

type ExecuteResponseState 

type ExecuteResponseState struct {
	Online bool                   `json:"online,omitempty"` // optional
	Others map[string]interface{} `json:"-"`                // optional, `json:",inline"` does not work, https://github.com/golang/go/issues/6213
}

func (ExecuteResponseState) MarshalJSON 

func (ers ExecuteResponseState) MarshalJSON() ([]byte, error)

reference taken from: https://stackoverflow.com/questions/49901287/embed-mapstringstring-in-go-json-marshaling-without-extra-json-property-inlin

type Input 

type Input struct {
	Intent string `json:"intent"`
}

Input struct

type NameData 

type NameData struct {
	Name         string   `json:"name"`                   // required
	DefaultNames []string `json:"defaultNames,omitempty"` // optional
	Nicknames    []string `json:"nicknames,omitempty"`    // optional
}

type OtherDeviceId 

type OtherDeviceId struct {
	AgentId       string `json:"agentId,omitempty"` // optional, The agent's ID. Generally, this is the project ID in the Actions console.
	OtherDeviceId string `json:"otherDeviceId"`     // required, Device ID defined by the agent. The device ID must be unique.
}

type QueryRequest 

type QueryRequest struct {
	RequestID string              `json:"requestId"` // required
	Inputs    []QueryRequestInput `json:"inputs"`    // required
}

QueryRequest struct https://developers.google.com/assistant/smarthome/reference/intent/query#request

type QueryRequestDevice 

type QueryRequestDevice struct {
	ID         string                 `json:"id"`                   // required
	CustomData map[string]interface{} `json:"customData,omitempty"` // optional
}

type QueryRequestInput 

type QueryRequestInput struct {
	Intent  string              `json:"intent"`  // required
	Payload QueryRequestPayload `json:"payload"` // required
}

QueryRequestInput struct

type QueryRequestPayload 

type QueryRequestPayload struct {
	Devices []QueryRequestDevice `json:"devices"` // required
}

type QueryResponse 

type QueryResponse struct {
	RequestID string               `json:"requestId"` // required
	Payload   QueryResponsePayload `json:"payload"`   // required
}

QueryResponse https://developers.google.com/assistant/smarthome/reference/intent/query#response

type QueryResponseDevice 

type QueryResponseDevice struct {
	Online    bool                   `json:"online"`              // required
	Status    string                 `json:"status"`              // required
	ErrorCode string                 `json:"errorCode,omitempty"` // optional
	Others    map[string]interface{} `json:"-"`                   // optional, `json:",inline"` does not work, https://github.com/golang/go/issues/6213
}

QueryResponseDevice struct

func (QueryResponseDevice) MarshalJSON 

func (qrd QueryResponseDevice) MarshalJSON() ([]byte, error)

reference taken from: https://stackoverflow.com/questions/49901287/embed-mapstringstring-in-go-json-marshaling-without-extra-json-property-inlin

type QueryResponsePayload 

type QueryResponsePayload struct {
	ErrorCode   string                         `json:"errorCode,omitempty"`   // optional
	DebugString string                         `json:"debugString,omitempty"` // optional
	Devices     map[string]QueryResponseDevice `json:"devices"`               // required
}

type Request 

type Request struct {
	RequestID string  `json:"requestId"`
	Inputs    []Input `json:"inputs"`
}

Request struct https://developers.google.com/assistant/smarthome/reference/intent/sync#request

type SyncResponse 

type SyncResponse struct {
	RequestID string              `json:"requestId"` // required
	Payload   SyncResponsePayload `json:"payload"`   // required
}

SyncResponse struct https://developers.google.com/assistant/smarthome/reference/intent/sync#response

type SyncResponseDevice 

type SyncResponseDevice struct {
	ID                           string                 `json:"id"`                           // required
	Type                         string                 `json:"type"`                         // required
	Traits                       []string               `json:"traits"`                       // required
	Name                         NameData               `json:"name"`                         // required
	WillReportState              bool                   `json:"willReportState"`              // required
	NotificationSupportedByAgent bool                   `json:"notificationSupportedByAgent"` // default false
	RoomHint                     string                 `json:"roomHint,omitempty"`           // optional
	DeviceInfo                   DeviceInfo             `json:"deviceInfo,omitempty"`         // optional
	Attributes                   map[string]interface{} `json:"attributes,omitempty"`         // optional
	CustomData                   map[string]interface{} `json:"customData,omitempty"`         // optional, maximum of 512 bytes per device
	OtherDeviceIds               []OtherDeviceId        `json:"otherDeviceIds,omitempty"`     // optional
}

type SyncResponsePayload 

type SyncResponsePayload struct {
	AgentUserId string               `json:"agentUserId"`           // required
	ErrorCode   string               `json:"errorCode,omitempty"`   // optional
	DebugString string               `json:"debugString,omitempty"` // optional
	Devices     []SyncResponseDevice `json:"devices"`               // required
}

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.