Documentation
¶
Index ¶
- Constants
- func NewMqttOptions(conf *viper.Viper, onConnect mqtt.OnConnectHandler, ...) *mqtt.ClientOptions
- type Address
- type AuthApiKey
- type AuthBearer
- type AuthNone
- type Authentication
- type Basic
- type Client
- func (c *Client) CreateDevice(dev *Device) (*Device, error)
- func (c *Client) CreateDeviceMeta(installationID, deviceID int64, key string, meta MetaObject, silent bool) (*MetaObject, error)
- func (c *Client) CreateEdgeApp(app *EdgeApp) (*EdgeApp, error)
- func (c *Client) CreateEdgeAppInstance(config *EdgeAppConfig) (*EdgeAppConfig, error)
- func (c *Client) CreateEdgeAppVersion(appID int64, luaFile, jsonFile io.Reader) (string, error)
- func (c *Client) CreateFileInstallation(installationID int64, fileName, mime string, r io.Reader) (*File, error)
- func (c *Client) CreateFileOrganization(organizationID int64, fileName, mime string, r io.Reader) (*File, error)
- func (c *Client) CreateFunction(fn *Function) (*Function, error)
- func (c *Client) CreateFunctionMeta(installationID, functionID int64, key string, meta MetaObject, silent bool) (*MetaObject, error)
- func (c *Client) CreateInstallationMeta(installationID int64, key string, meta MetaObject, silent bool) (*MetaObject, error)
- func (c *Client) CreateNotificationMessage(installationID int64, message *NotificationMessage) (*NotificationMessage, error)
- func (c *Client) CreateNotificationOutput(output *NotificationOutput) (*NotificationOutput, error)
- func (c *Client) CreateOrganization(org *Organization) (*Organization, error)
- func (c *Client) CreateOrganizationMeta(organizationID int64, key string, meta MetaObject, silent bool) (*MetaObject, error)
- func (c *Client) CreateSchedule(s *Schedule) (*Schedule, error)
- func (c *Client) CreateUserMeta(userID int64, key string, meta MetaObject, silent bool) (*MetaObject, error)
- func (c *Client) DeleteDevice(dev *Device) error
- func (c *Client) DeleteDeviceMeta(installationID, deviceID int64, key string, silent bool) error
- func (c *Client) DeleteEdgeAppInstance(config *EdgeAppConfig) error
- func (c *Client) DeleteFileInstallation(installationID, fileID int64) error
- func (c *Client) DeleteFileOrganization(organizationID, fileID int64) error
- func (c *Client) DeleteFunction(fn *Function) error
- func (c *Client) DeleteFunctionMeta(installationID, functionID int64, key string, silent bool) error
- func (c *Client) DeleteInstallationMeta(installationID int64, key string, silent bool) error
- func (c *Client) DeleteNotificationMessage(installationID int64, message *NotificationMessage) error
- func (c *Client) DeleteNotificationOutput(output *NotificationOutput) error
- func (c *Client) DeleteOrganization(org *Organization, force bool) error
- func (c *Client) DeleteOrganizationMeta(organizationID int64, key string, silent bool) error
- func (c *Client) DeleteSchedule(s *Schedule) error
- func (c *Client) DeleteUserMeta(userID int64, key string, silent bool) error
- func (c *Client) DownloadEdgeApp(id int64, version string) ([]byte, error)
- func (c *Client) DownloadFile(hash string) (io.ReadCloser, error)
- func (c *Client) ForcePasswordReset(organizationID int64) error
- func (c *Client) GetConfiguredEdgeApps(installationID int64) ([]*EdgeAppConfig, error)
- func (c *Client) GetDevice(installationID, deviceID int64) (*Device, error)
- func (c *Client) GetDeviceMeta(installationID, deviceID int64, key string) (*MetaObject, error)
- func (c *Client) GetDevices(installationID int64, filter Filter) (DeviceList, error)
- func (c *Client) GetEdgeApp(id int64) (*EdgeApp, error)
- func (c *Client) GetEdgeAppConfigOptions(appID int64, version string) (json.RawMessage, error)
- func (c *Client) GetEdgeAppInstance(InstallationID, instanceID int64) (*EdgeAppConfig, error)
- func (c *Client) GetEdgeAppVersions(appID int64, untagged bool) ([]*EdgeAppVersion, error)
- func (c *Client) GetEdgeApps() ([]*EdgeApp, error)
- func (c *Client) GetEdgeAppsOrganization(organizationID int64, available bool) ([]*EdgeApp, error)
- func (c *Client) GetFileInstallation(installationID, fileID int64) (*File, error)
- func (c *Client) GetFileOrganization(organizationID, fileID int64) (*File, error)
- func (c *Client) GetFilesInstallation(installationID int64) ([]*File, error)
- func (c *Client) GetFilesOrganization(organizationID int64) ([]*File, error)
- func (c *Client) GetFunction(installationID, functionID int64) (*Function, error)
- func (c *Client) GetFunctionMeta(installationID, functionID int64, key string) (*MetaObject, error)
- func (c *Client) GetFunctions(installationID int64, filter Filter) (FunctionList, error)
- func (c *Client) GetInstallation(installationID int64) (*Installation, error)
- func (c *Client) GetInstallationByClientID(clientID int64, assignedOnly bool) (*Installation, error)
- func (c *Client) GetInstallationMeta(installationID int64, key string) (*MetaObject, error)
- func (c *Client) GetInstallationRow(installationID int64) (*InstallationRow, error)
- func (c *Client) GetInstallations(assignedOnly bool) ([]*Installation, error)
- func (c *Client) GetNotificationMessage(installationID, messageID int64) (*NotificationMessage, error)
- func (c *Client) GetNotificationMessages(installationID int64) ([]*NotificationMessage, error)
- func (c *Client) GetNotificationOutput(installationID, outputID int64) (*NotificationOutput, error)
- func (c *Client) GetNotificationOutputExecutor(installationID, executorID int64) (*NotificationOutputExecutor, error)
- func (c *Client) GetNotificationOutputExecutors(installationID int64) ([]*NotificationOutputExecutor, error)
- func (c *Client) GetNotificationOutputs(installationID int64) ([]*NotificationOutput, error)
- func (c *Client) GetOrganization(organizationID int64) (*Organization, error)
- func (c *Client) GetOrganizationMeta(organizationID int64, key string) (*MetaObject, error)
- func (c *Client) GetSchedule(installationID, scheduleID int64) (*Schedule, error)
- func (c *Client) GetSchedules(installationID int64, executor string) ([]*Schedule, error)
- func (c *Client) GetTraces(opts *TraceOptions) (*TracePage, error)
- func (c *Client) GetUserMeta(userID int64, key string) (*MetaObject, error)
- func (c *Client) GetUsers(filter Filter) ([]*User, error)
- func (c *Client) ListInstallations(filter Filter) ([]*InstallationRow, error)
- func (c *Client) ListOrganization(minimal bool, filter Filter) ([]*Organization, error)
- func (c *Client) MQTTConnect() error
- func (c *Client) MQTTDisconnect()
- func (c *Client) Me() (*User, error)
- func (c *Client) NameEdgeAppVersion(appID int64, version *EdgeAppVersion) (*EdgeAppVersion, error)
- func (c *Client) Ping() error
- func (c *Client) Publish(topic string, payload interface{}, qos byte) error
- func (c *Client) SendNotification(installationID, outputID int64, data interface{}) error
- func (c *Client) Status(installationID int64, topicFilter []string) (Status, error)
- func (c *Client) UpdateDevice(dev *Device) (*Device, error)
- func (c *Client) UpdateDeviceMeta(installationID, deviceID int64, key string, meta MetaObject, ...) (*MetaObject, error)
- func (c *Client) UpdateEdgeAppInstance(config *EdgeAppConfig) (*EdgeAppConfig, error)
- func (c *Client) UpdateFileInstallation(installationID, fileID int64, fileName, mime string, r io.Reader) (*File, error)
- func (c *Client) UpdateFileOrganization(organizationID, fileID int64, fileName, mime string, r io.Reader) (*File, error)
- func (c *Client) UpdateFunction(fn *Function) (*Function, error)
- func (c *Client) UpdateFunctionMeta(installationID, functionID int64, key string, meta MetaObject, ...) (*MetaObject, error)
- func (c *Client) UpdateInstallation(i *InstallationRow) (*InstallationRow, error)
- func (c *Client) UpdateInstallationMeta(installationID int64, key string, meta MetaObject, silent, createMissing bool) (*MetaObject, error)
- func (c *Client) UpdateMe(u *User) (*User, error)
- func (c *Client) UpdateNotificationMessage(installationID int64, message *NotificationMessage) (*NotificationMessage, error)
- func (c *Client) UpdateNotificationOutput(output *NotificationOutput) (*NotificationOutput, error)
- func (c *Client) UpdateOrganization(org *Organization) (*Organization, error)
- func (c *Client) UpdateOrganizationMeta(organizationID int64, key string, meta MetaObject, silent, createMissing bool) (*MetaObject, error)
- func (c *Client) UpdateSchedule(s *Schedule) (*Schedule, error)
- func (c *Client) UpdateUser(u *User) (*User, error)
- func (c *Client) UpdateUserMeta(userID int64, key string, meta MetaObject, silent, createMissing bool) (*MetaObject, error)
- func (c *Client) V3() *V3Client
- type Device
- type DeviceList
- type EdgeApp
- type EdgeAppConfig
- type EdgeAppVersion
- type Error
- type File
- type Filter
- type Function
- type FunctionList
- type Installation
- type InstallationRow
- type LogEntry
- type LogOptionsV3
- type LogOrder
- type Message
- type Meta
- func (m Meta) AsBool(key string) (bool, error)
- func (m Meta) AsFloat64(key string) (float64, error)
- func (m Meta) AsInt(key string) (int, error)
- func (m Meta) AsInt16(key string) (int16, error)
- func (m Meta) AsInt32(key string) (int32, error)
- func (m Meta) AsInt64(key string) (int64, error)
- func (m Meta) AsInt8(key string) (int8, error)
- func (m Meta) AsUint(key string) (uint, error)
- func (m Meta) AsUint16(key string) (uint16, error)
- func (m Meta) AsUint32(key string) (uint32, error)
- func (m Meta) AsUint64(key string) (uint64, error)
- func (m Meta) AsUint8(key string) (uint8, error)
- type MetaObject
- type NotificationExecutorPayload
- type NotificationMessage
- type NotificationOutput
- type NotificationOutputExecutor
- type Options
- type Organization
- type OrganizationChild
- type OrganizationList
- type Publisher
- type Schedule
- type Status
- type TraceAction
- type TraceEntry
- type TraceObjectType
- type TraceOptions
- type TracePage
- type User
- type V3Client
- type V3Log
Constants ¶
View Source
const ( LogOrderDesc = LogOrder("desc") LogOrderAsc = LogOrder("asc") )
View Source
const ( TraceObjectTypeNone = TraceObjectType("") TraceObjectTypeInstallation = TraceObjectType("installation") TraceObjectTypeGateway = TraceObjectType("gateway") TraceObjectTypeOrganization = TraceObjectType("organization") TraceObjectTypeUser = TraceObjectType("user") TraceObjectTypeDevice = TraceObjectType("device") TraceObjectTypeFunction = TraceObjectType("function") TraceObjectTypeSchedule = TraceObjectType("schedule") TraceObjectTypeNotificationOutput = TraceObjectType("notification_output") TraceObjectTypeNotificationMessage = TraceObjectType("notification_message") TraceObjectTypeOutputExecutor = TraceObjectType("output_executor") TraceObjectTypeEdgeApp = TraceObjectType("edge_app") TraceObjectTypeEdgeAppInstance = TraceObjectType("edge_app_instance") TraceObjectTypeFile = TraceObjectType("file") TraceObjectTypeRole = TraceObjectType("role") TraceObjectTypeGatewayRegistrationPolicy = TraceObjectType("gateway_registration_policy") TraceObjectTypeUserRegistrationPolicy = TraceObjectType("user_registration_policy") TraceObjectTypeMQTT = TraceObjectType("mqtt") TraceObjectTypeTrace = TraceObjectType("trace") )
View Source
const ( TraceActionCreate = TraceAction("create") TraceActionDelete = TraceAction("delete") TraceActionUpdate = TraceAction("update") TraceActionView = TraceAction("view") TraceActionFailed = TraceAction("failed") TraceActionExecute = TraceAction("execute") TraceActionAuth = TraceAction("auth") )
Variables ¶
This section is empty.
Functions ¶
func NewMqttOptions ¶
func NewMqttOptions(conf *viper.Viper, onConnect mqtt.OnConnectHandler, onLost mqtt.ConnectionLostHandler) *mqtt.ClientOptions
NewMqttOptions returns default mqtt configuration conf is a subset of a viper config which can include: broker, the MQTT broker URI client_id, id to be used by the client connection_log, boolean value for enabling/disabling connection logging timeout, the connect-timeout to be used on the client. Defaults to 30s
Types ¶
type AuthApiKey ¶
type AuthApiKey struct {
Key string
}
func (AuthApiKey) SetHTTPAuth ¶
func (a AuthApiKey) SetHTTPAuth(r *http.Request)
func (AuthApiKey) SetMQTTAuth ¶
func (a AuthApiKey) SetMQTTAuth(o *mqtt.ClientOptions)
type AuthBearer ¶
type AuthBearer struct {
Token string
}
func (AuthBearer) SetHTTPAuth ¶
func (a AuthBearer) SetHTTPAuth(r *http.Request)
func (AuthBearer) SetMQTTAuth ¶
func (a AuthBearer) SetMQTTAuth(o *mqtt.ClientOptions)
type AuthNone ¶
type AuthNone struct{}
func (AuthNone) SetHTTPAuth ¶
func (AuthNone) SetMQTTAuth ¶
func (a AuthNone) SetMQTTAuth(o *mqtt.ClientOptions)
type Authentication ¶
type Authentication interface { SetHTTPAuth(r *http.Request) SetMQTTAuth(o *mqtt.ClientOptions) }
type Basic ¶
func (Basic) SetHTTPAuth ¶
func (Basic) SetMQTTAuth ¶
func (b Basic) SetMQTTAuth(o *mqtt.ClientOptions)
type Client ¶
Client is the main client for Lynx integration
func (*Client) CreateDeviceMeta ¶
func (c *Client) CreateDeviceMeta(installationID, deviceID int64, key string, meta MetaObject, silent bool) (*MetaObject, error)
func (*Client) CreateEdgeAppInstance ¶
func (c *Client) CreateEdgeAppInstance(config *EdgeAppConfig) (*EdgeAppConfig, error)
func (*Client) CreateEdgeAppVersion ¶
func (*Client) CreateFileInstallation ¶
func (*Client) CreateFileOrganization ¶
func (*Client) CreateFunctionMeta ¶
func (c *Client) CreateFunctionMeta(installationID, functionID int64, key string, meta MetaObject, silent bool) (*MetaObject, error)
func (*Client) CreateInstallationMeta ¶
func (c *Client) CreateInstallationMeta(installationID int64, key string, meta MetaObject, silent bool) (*MetaObject, error)
func (*Client) CreateNotificationMessage ¶
func (c *Client) CreateNotificationMessage(installationID int64, message *NotificationMessage) (*NotificationMessage, error)
func (*Client) CreateNotificationOutput ¶
func (c *Client) CreateNotificationOutput(output *NotificationOutput) (*NotificationOutput, error)
func (*Client) CreateOrganization ¶
func (c *Client) CreateOrganization(org *Organization) (*Organization, error)
func (*Client) CreateOrganizationMeta ¶
func (c *Client) CreateOrganizationMeta(organizationID int64, key string, meta MetaObject, silent bool) (*MetaObject, error)
func (*Client) CreateUserMeta ¶
func (c *Client) CreateUserMeta(userID int64, key string, meta MetaObject, silent bool) (*MetaObject, error)
func (*Client) DeleteDevice ¶
func (*Client) DeleteDeviceMeta ¶
func (*Client) DeleteEdgeAppInstance ¶
func (c *Client) DeleteEdgeAppInstance(config *EdgeAppConfig) error
func (*Client) DeleteFileInstallation ¶
func (*Client) DeleteFileOrganization ¶
func (*Client) DeleteFunction ¶
func (*Client) DeleteFunctionMeta ¶
func (*Client) DeleteInstallationMeta ¶
func (*Client) DeleteNotificationMessage ¶
func (c *Client) DeleteNotificationMessage(installationID int64, message *NotificationMessage) error
func (*Client) DeleteNotificationOutput ¶
func (c *Client) DeleteNotificationOutput(output *NotificationOutput) error
func (*Client) DeleteOrganization ¶
func (c *Client) DeleteOrganization(org *Organization, force bool) error
func (*Client) DeleteOrganizationMeta ¶
func (*Client) DeleteSchedule ¶
func (*Client) DeleteUserMeta ¶
func (*Client) DownloadEdgeApp ¶
func (*Client) DownloadFile ¶
func (c *Client) DownloadFile(hash string) (io.ReadCloser, error)
func (*Client) ForcePasswordReset ¶
func (*Client) GetConfiguredEdgeApps ¶
func (c *Client) GetConfiguredEdgeApps(installationID int64) ([]*EdgeAppConfig, error)
func (*Client) GetDeviceMeta ¶
func (c *Client) GetDeviceMeta(installationID, deviceID int64, key string) (*MetaObject, error)
func (*Client) GetDevices ¶
func (c *Client) GetDevices(installationID int64, filter Filter) (DeviceList, error)
func (*Client) GetEdgeAppConfigOptions ¶
func (*Client) GetEdgeAppInstance ¶
func (c *Client) GetEdgeAppInstance(InstallationID, instanceID int64) (*EdgeAppConfig, error)
func (*Client) GetEdgeAppVersions ¶
func (c *Client) GetEdgeAppVersions(appID int64, untagged bool) ([]*EdgeAppVersion, error)
func (*Client) GetEdgeApps ¶
func (*Client) GetEdgeAppsOrganization ¶
func (*Client) GetFileInstallation ¶
func (*Client) GetFileOrganization ¶
func (*Client) GetFilesInstallation ¶
func (*Client) GetFilesOrganization ¶
func (*Client) GetFunction ¶
func (*Client) GetFunctionMeta ¶
func (c *Client) GetFunctionMeta(installationID, functionID int64, key string) (*MetaObject, error)
func (*Client) GetFunctions ¶
func (c *Client) GetFunctions(installationID int64, filter Filter) (FunctionList, error)
func (*Client) GetInstallation ¶
func (c *Client) GetInstallation(installationID int64) (*Installation, error)
func (*Client) GetInstallationByClientID ¶
func (c *Client) GetInstallationByClientID(clientID int64, assignedOnly bool) (*Installation, error)
func (*Client) GetInstallationMeta ¶
func (c *Client) GetInstallationMeta(installationID int64, key string) (*MetaObject, error)
func (*Client) GetInstallationRow ¶
func (c *Client) GetInstallationRow(installationID int64) (*InstallationRow, error)
func (*Client) GetInstallations ¶
func (c *Client) GetInstallations(assignedOnly bool) ([]*Installation, error)
func (*Client) GetNotificationMessage ¶
func (c *Client) GetNotificationMessage(installationID, messageID int64) (*NotificationMessage, error)
func (*Client) GetNotificationMessages ¶
func (c *Client) GetNotificationMessages(installationID int64) ([]*NotificationMessage, error)
func (*Client) GetNotificationOutput ¶
func (c *Client) GetNotificationOutput(installationID, outputID int64) (*NotificationOutput, error)
func (*Client) GetNotificationOutputExecutor ¶
func (c *Client) GetNotificationOutputExecutor(installationID, executorID int64) (*NotificationOutputExecutor, error)
func (*Client) GetNotificationOutputExecutors ¶
func (c *Client) GetNotificationOutputExecutors(installationID int64) ([]*NotificationOutputExecutor, error)
func (*Client) GetNotificationOutputs ¶
func (c *Client) GetNotificationOutputs(installationID int64) ([]*NotificationOutput, error)
func (*Client) GetOrganization ¶
func (c *Client) GetOrganization(organizationID int64) (*Organization, error)
func (*Client) GetOrganizationMeta ¶
func (c *Client) GetOrganizationMeta(organizationID int64, key string) (*MetaObject, error)
func (*Client) GetSchedule ¶
func (*Client) GetSchedules ¶
func (*Client) GetUserMeta ¶
func (c *Client) GetUserMeta(userID int64, key string) (*MetaObject, error)
func (*Client) ListInstallations ¶
func (c *Client) ListInstallations(filter Filter) ([]*InstallationRow, error)
func (*Client) ListOrganization ¶
func (c *Client) ListOrganization(minimal bool, filter Filter) ([]*Organization, error)
func (*Client) MQTTConnect ¶
func (*Client) MQTTDisconnect ¶
func (c *Client) MQTTDisconnect()
func (*Client) NameEdgeAppVersion ¶
func (c *Client) NameEdgeAppVersion(appID int64, version *EdgeAppVersion) (*EdgeAppVersion, error)
func (*Client) SendNotification ¶
func (*Client) UpdateDeviceMeta ¶
func (c *Client) UpdateDeviceMeta(installationID, deviceID int64, key string, meta MetaObject, silent, createMissing bool) (*MetaObject, error)
func (*Client) UpdateEdgeAppInstance ¶
func (c *Client) UpdateEdgeAppInstance(config *EdgeAppConfig) (*EdgeAppConfig, error)
func (*Client) UpdateFileInstallation ¶
func (*Client) UpdateFileOrganization ¶
func (*Client) UpdateFunctionMeta ¶
func (c *Client) UpdateFunctionMeta(installationID, functionID int64, key string, meta MetaObject, silent, createMissing bool) (*MetaObject, error)
func (*Client) UpdateInstallation ¶
func (c *Client) UpdateInstallation(i *InstallationRow) (*InstallationRow, error)
func (*Client) UpdateInstallationMeta ¶
func (c *Client) UpdateInstallationMeta(installationID int64, key string, meta MetaObject, silent, createMissing bool) (*MetaObject, error)
func (*Client) UpdateNotificationMessage ¶
func (c *Client) UpdateNotificationMessage(installationID int64, message *NotificationMessage) (*NotificationMessage, error)
func (*Client) UpdateNotificationOutput ¶
func (c *Client) UpdateNotificationOutput(output *NotificationOutput) (*NotificationOutput, error)
func (*Client) UpdateOrganization ¶
func (c *Client) UpdateOrganization(org *Organization) (*Organization, error)
func (*Client) UpdateOrganizationMeta ¶
func (c *Client) UpdateOrganizationMeta(organizationID int64, key string, meta MetaObject, silent, createMissing bool) (*MetaObject, error)
func (*Client) UpdateUserMeta ¶
func (c *Client) UpdateUserMeta(userID int64, key string, meta MetaObject, silent, createMissing bool) (*MetaObject, error)
type DeviceList ¶
type DeviceList []*Device
func (DeviceList) MapByID ¶
func (d DeviceList) MapByID() map[int64]*Device
func (DeviceList) MapByList ¶
func (d DeviceList) MapByList(key string) map[string]DeviceList
type EdgeApp ¶
type EdgeApp struct { ID int64 `json:"id"` Name string `json:"name"` Category string `json:"category"` Tags []string `json:"tags"` ShortDescription string `json:"short_description"` Description string `json:"description"` Publisher *Publisher `json:"publisher,omitempty"` Official bool `json:"official"` Public bool `json:"public"` SourceURL string `json:"source_url"` Created int64 `json:"created"` Updated int64 `json:"updated"` }
type EdgeAppConfig ¶
type EdgeAppVersion ¶
type Filter ¶
func (Filter) ToURLValues ¶
type Function ¶
type Function struct { ID int64 `json:"id"` Type string `json:"type"` InstallationID int64 `json:"installation_id"` Meta Meta `json:"meta"` ProtectedMeta Meta `json:"protected_meta"` Created int64 `json:"created"` Updated int64 `json:"updated"` }
func (*Function) FormatValue ¶
FormatValue formats a value according to the function meta-data parameters.
Functions are formatted using a set of rules in the order:
- The format_<topicKey> for the topicKey used
- The format meta-ket
- Using value+unit
- By matching the value to the state_<key> and looking for text_<key> for that value and state
- Using a normal float format string
func (*Function) GetStatesRev ¶
type FunctionList ¶
type FunctionList []*Function
func (FunctionList) MapByID ¶
func (f FunctionList) MapByID() map[int64]*Function
func (FunctionList) MapByList ¶
func (f FunctionList) MapByList(key string) map[string]FunctionList
type Installation ¶
type InstallationRow ¶
type InstallationRow struct { ID int64 `json:"id"` Name string `json:"name"` ClientID int64 `json:"client_id"` Created int64 `json:"created"` OrganizationID int64 `json:"organization_id"` Notes string `json:"notes"` Users []int64 `json:"users"` Meta Meta `json:"meta"` ProtectedMeta Meta `json:"protected_meta"` }
type LogEntry ¶
type LogOptionsV3 ¶
type Message ¶
type MetaObject ¶
type NotificationExecutorPayload ¶
type NotificationExecutorPayload struct { Message string `json:"message"` OutputConfig map[string]string `json:"output_config"` ExecutorConfig map[string]string `json:"executor_config"` Organization Organization `json:"organization"` Installation Installation `json:"installation"` Payload map[string]any `json:"payload"` }
type NotificationMessage ¶
type NotificationOutput ¶
type NotificationOutput struct { ID int64 `json:"id"` Name string `json:"name"` InstallationID int64 `json:"installation_id"` NotificationOutputExecutorID int64 `json:"notification_output_executor_id"` NotificationMessageID int64 `json:"notification_message_id"` Config map[string]string `json:"config"` }
type Options ¶
type Options struct { Authenticator Authentication APIBase string MqttOptions *mqtt.ClientOptions HTTPClient *http.Client }
Options is connection options for the client
type Organization ¶
type Organization struct { ID int64 `json:"id"` Name string `json:"name"` Address Address `json:"address"` Email string `json:"email"` Phone string `json:"phone"` ForceSMSLogin bool `json:"force_sms_login"` Parent int64 `json:"parent"` Children []*OrganizationChild `json:"children"` Notes string `json:"notes"` Meta Meta `json:"meta"` ProtectedMeta Meta `json:"protected_meta"` }
type OrganizationChild ¶
type OrganizationList ¶
type OrganizationList []*Organization
func (OrganizationList) MapByID ¶
func (ol OrganizationList) MapByID() map[int64]*Organization
type Schedule ¶
type Schedule struct { ID int64 `json:"id"` InstallationID int64 `json:"installation_id"` Executor string `json:"executor"` Active bool `json:"active"` DayOfWeek string `json:"day_of_week"` DayOfMonth string `json:"day_of_month"` Month string `json:"month"` Hour string `json:"hour"` Minute string `json:"minute"` Topic string `json:"topic"` Value float64 `json:"value"` Created int64 `json:"created_at"` Updated int64 `json:"updated_at"` }
type TraceAction ¶
type TraceAction string
type TraceEntry ¶
type TraceEntry struct { ID string `json:"id"` Path string `json:"path"` Method string `json:"method"` Timestamp float64 `json:"timestamp"` UserID int64 `json:"user_id"` Action TraceAction `json:"action"` ObjectType TraceObjectType `json:"object_type"` ObjectID int64 `json:"object_id"` Description string `json:"description"` }
type TraceObjectType ¶
type TraceObjectType string
type TraceOptions ¶
type TracePage ¶
type TracePage struct { Total int64 `json:"total"` LastTime float64 `json:"last"` Count int `json:"count"` Data []TraceEntry `json:"data"` }
type User ¶
type User struct { ID int64 `json:"id"` Email string `json:"email"` FirstName string `json:"first_name"` LastName string `json:"last_name"` Role int64 `json:"role"` SmsLogin bool `json:"sms_login"` Address Address `json:"address"` Mobile string `json:"mobile"` Organizations []int64 `json:"organisations"` Meta Meta `json:"meta"` ProtectedMeta Meta `json:"protected_meta"` }
Click to show internal directories.
Click to hide internal directories.