nodeinterface

package
v1.0.1 Latest Latest
Warning

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

Go to latest
Published: Feb 25, 2021 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// *** UnitType ***
	FuncUnitTypeList       = "unit_types_list"
	FuncUnitTypeCategories = "unit_categories"
	FuncUnitTypeConfigMeta = "unit_config_by_type"

	// *** Unit ***
	FuncUnitAdd         = "add_unit"
	FuncUnitRemove      = "remove_unit"
	FuncUnitState       = "unit_state"
	FuncUnitItemsValues = "unit_values"
	FuncUnitList        = "units"
	FuncUnitStart       = "start_units"
	FuncUnitStop        = "stop_units"
	FuncUnitSetConfig   = "set_unit_config"
	FuncUnitGetConfig   = "unit_config"

	// *** Data Item ***
	FuncDataItemList    = "items"
	FuncDataItemListAll = "all_items"
	FuncDataItemWrite   = "write"
	FuncDataItemHistory = "history"

	// *** Public Channel ***
	FuncPublicChannelList       = "cloud_channels"
	FuncPublicChannelAdd        = "add_cloud_channel"
	FuncPublicChannelSetName    = "edit_cloud_channel"
	FuncPublicChannelRemove     = "remove_cloud_channel"
	FuncPublicChannelItemAdd    = "cloud_add_items"
	FuncPublicChannelItemRemove = "cloud_remove_items"
	FuncPublicChannelItemsState = "cloud_channel_values"

	// *** Service ***
	FuncServiceLookup     = "lookup"
	FuncServiceStatistics = "statistics"

	// *** Resource ***
	FuncResourceAdd    = "res_add"
	FuncResourceSet    = "res_set"
	FuncResourceGet    = "res_get"
	FuncResourceRemove = "res_remove"
	FuncResourceRename = "res_rename"
	FuncResourceList   = "res_list"

	// *** User ***
	FuncSessionOpen     = "session_open"
	FuncSessionActivate = "session_activate"
	FuncSessionRemove   = "session_remove"
	FuncSessionList     = "session_list"

	FuncUserList        = "user_list"
	FuncUserAdd         = "user_add"
	FuncUserSetPassword = "user_set_password"
	FuncUserRemove      = "user_remove"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type DataItemHistoryRequest

type DataItemHistoryRequest struct {
	Name    string `json:"name"`
	DTBegin int64  `json:"dt_begin"`
	DTEnd   int64  `json:"dt_end"`
}

type DataItemHistoryResponse

type DataItemHistoryResponse struct {
	ReadResult *history.ReadResult
}

type DataItemListAllRequest

type DataItemListAllRequest struct {
}

type DataItemListAllResponse

type DataItemListAllResponse struct {
	UnitValues []common_interfaces.ItemGetUnitItems
}

type DataItemListRequest

type DataItemListRequest struct {
	Items []string `json:"items"`
}

type DataItemListResponse

type DataItemListResponse struct {
	UnitValues []common_interfaces.ItemGetUnitItems
}

type DataItemWriteRequest

type DataItemWriteRequest struct {
	ItemName string `json:"item_name"`
	Value    string `json:"value"`
}

type DataItemWriteResponse

type DataItemWriteResponse struct {
}

type PublicChannelAddRequest

type PublicChannelAddRequest struct {
	ChannelName string `json:"name"`
}

type PublicChannelAddResponse

type PublicChannelAddResponse struct {
}

type PublicChannelItemAddRequest

type PublicChannelItemAddRequest struct {
	Channels []string `json:"ids"`
	Items    []string `json:"items"`
}

type PublicChannelItemAddResponse

type PublicChannelItemAddResponse struct {
}

type PublicChannelItemRemoveRequest

type PublicChannelItemRemoveRequest struct {
	Channels []string `json:"ids"`
	Items    []string `json:"items"`
}

type PublicChannelItemRemoveResponse

type PublicChannelItemRemoveResponse struct {
}

type PublicChannelItemsStateRequest

type PublicChannelItemsStateRequest struct {
	ChannelId string `json:"id"`
}

type PublicChannelItemsStateResponse

type PublicChannelItemsStateResponse struct {
	UnitValues []common_interfaces.Item
}

type PublicChannelListRequest

type PublicChannelListRequest struct {
}

type PublicChannelListResponse

type PublicChannelListResponse struct {
	Channels []cloud.ChannelInfo
}

type PublicChannelRemoveRequest

type PublicChannelRemoveRequest struct {
	ChannelId string `json:"id"`
}

type PublicChannelRemoveResponse

type PublicChannelRemoveResponse struct {
}

type PublicChannelSetNameRequest

type PublicChannelSetNameRequest struct {
	ChannelId   string `json:"id"`
	ChannelName string `json:"name"`
}

type PublicChannelSetNameResponse

type PublicChannelSetNameResponse struct {
}

type ResourceAddRequest

type ResourceAddRequest struct {
	Name    string
	Type    string
	Content []byte
}

type ResourceAddResponse

type ResourceAddResponse struct {
	Id string
}

type ResourceGetRequest

type ResourceGetRequest struct {
	Id string
}

type ResourceGetResponse

type ResourceGetResponse struct {
	Item *common_interfaces.ResourcesItem
}

type ResourceListRequest

type ResourceListRequest struct {
	Type     string `json:"type"`
	Filter   string `json:"filter"`
	Offset   int    `json:"offset"`
	MaxCount int    `json:"max_count"`
}

type ResourceListResponse

type ResourceListResponse struct {
	Items common_interfaces.ResourcesInfo
}

type ResourceRemoveRequest

type ResourceRemoveRequest struct {
	Id string `json:"id"`
}

type ResourceRemoveResponse

type ResourceRemoveResponse struct {
}

type ResourceRenameRequest

type ResourceRenameRequest struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

type ResourceRenameResponse

type ResourceRenameResponse struct {
}

type ResourceSetRequest

type ResourceSetRequest struct {
	Id        string `json:"id"`
	Thumbnail []byte `json:"thumbnail"`
	Content   []byte `json:"content"`
}

type ResourceSetResponse

type ResourceSetResponse struct {
}

type ServiceLookupRequest

type ServiceLookupRequest struct {
	Entity     string `json:"entity"`
	Parameters string `json:"parameters"`
}

type ServiceLookupResponse

type ServiceLookupResponse struct {
	Result lookup.Result
}

type ServiceStatisticsRequest

type ServiceStatisticsRequest struct {
}

type ServiceStatisticsResponse

type ServiceStatisticsResponse struct {
	Stat common_interfaces.Statistics
}

type SessionActivateRequest added in v1.0.1

type SessionActivateRequest struct {
	SessionToken string `json:"session_token"`
}

type SessionActivateResponse added in v1.0.1

type SessionActivateResponse struct {
	SessionToken string `json:"session_token"`
}

type SessionListRequest added in v1.0.1

type SessionListRequest struct {
	UserName string `json:"user_name"`
}

type SessionListResponse added in v1.0.1

type SessionListResponse struct {
	Items []SessionListResponseItem `json:"items"`
}

type SessionListResponseItem added in v1.0.1

type SessionListResponseItem struct {
	SessionToken    string `json:"session_token"`
	UserName        string `json:"user_name"`
	SessionOpenTime int64  `json:"session_open_time"`
}

type SessionOpenRequest

type SessionOpenRequest struct {
	UserName string `json:"user_name"`
	Password string `json:"password"`
}

type SessionOpenResponse

type SessionOpenResponse struct {
	SessionToken string `json:"session_token"`
}

type SessionRemoveRequest added in v1.0.1

type SessionRemoveRequest struct {
	SessionToken string `json:"session_token"`
}

type SessionRemoveResponse added in v1.0.1

type SessionRemoveResponse struct {
}

type UnitAddRequest

type UnitAddRequest struct {
	UnitType string `json:"type"`
	UnitName string `json:"name"`
}

type UnitAddResponse

type UnitAddResponse struct {
	UnitId string `json:"unit_id"`
}

type UnitGetConfigRequest

type UnitGetConfigRequest struct {
	UnitId string `json:"id"`
}

type UnitGetConfigResponse

type UnitGetConfigResponse struct {
	UnitId         string `json:"id"`
	UnitName       string `json:"name"`
	UnitType       string `json:"type"`
	UnitConfig     string `json:"config"`
	UnitConfigMeta string `json:"config_meta"`
}

type UnitItemsValuesRequest

type UnitItemsValuesRequest struct {
	UnitName string `json:"unit_name"`
}

type UnitItemsValuesResponse

type UnitItemsValuesResponse struct {
	Items []common_interfaces.ItemGetUnitItems `json:"items"`
}

type UnitListRequest

type UnitListRequest struct {
}

type UnitListResponse

type UnitListResponse struct {
	Items []UnitListResponseItem `json:"items"`
}

type UnitListResponseItem

type UnitListResponseItem struct {
	Id             string `json:"id"`
	Name           string `json:"name"`
	Type           string `json:"type"`
	TypeForDisplay string `json:"type_for_display"`
	Config         string `json:"config"`
	Enable         bool   `json:"enable"`
}

type UnitRemoveRequest

type UnitRemoveRequest struct {
	Units []string `json:"ids"`
}

type UnitRemoveResponse

type UnitRemoveResponse struct {
}

type UnitSetConfigRequest

type UnitSetConfigRequest struct {
	UnitId     string `json:"id"`
	UnitName   string `json:"name"`
	UnitConfig string `json:"config"`
}

type UnitSetConfigResponse

type UnitSetConfigResponse struct {
}

type UnitStartRequest

type UnitStartRequest struct {
	Ids []string `json:"ids"`
}

type UnitStartResponse

type UnitStartResponse struct {
}

type UnitStateRequest

type UnitStateRequest struct {
	UnitId string `json:"id"`
}

type UnitStateResponse

type UnitStateResponse struct {
	UnitId   string
	UnitName string
	Status   string
	MainItem string
	Value    string
	UOM      string
}

type UnitStopRequest

type UnitStopRequest struct {
	Ids []string `json:"ids"`
}

type UnitStopResponse

type UnitStopResponse struct {
}

type UnitTypeCategoriesRequest

type UnitTypeCategoriesRequest struct {
}

type UnitTypeCategoriesResponse

type UnitTypeCategoriesResponse struct {
	Items []UnitTypeCategoriesResponseItem `json:"items"`
}

type UnitTypeCategoriesResponseItem

type UnitTypeCategoriesResponseItem struct {
	Name  string `json:"name"`
	Image []byte `json:"image"`
}

type UnitTypeConfigMetaRequest

type UnitTypeConfigMetaRequest struct {
	UnitType string `json:"type"`
}

type UnitTypeConfigMetaResponse

type UnitTypeConfigMetaResponse struct {
	UnitId         string `json:"id"`
	UnitName       string `json:"name"`
	UnitConfigMeta string `json:"config_meta"`
}

type UnitTypeListRequest

type UnitTypeListRequest struct {
	Category string `json:"category"`
	Filter   string `json:"filter"`
	Offset   int    `json:"offset"`
	MaxCount int    `json:"max_count"`
}

type UnitTypeListResponse

type UnitTypeListResponse struct {
	TotalCount    int                        `json:"total_count"`
	InFilterCount int                        `json:"in_filter_count"`
	Types         []UnitTypeListResponseItem `json:"types"`
}

type UnitTypeListResponseItem

type UnitTypeListResponseItem struct {
	Type        string `json:"type"`
	Category    string `json:"category"`
	DisplayName string `json:"display_name"`
	Help        string `json:"help"`
	Description string `json:"description"`
	Image       []byte `json:"image"`
}

type UserAddRequest added in v1.0.1

type UserAddRequest struct {
	UserName string `json:"user_name"`
	Password string `json:"password"`
}

type UserAddResponse added in v1.0.1

type UserAddResponse struct {
}

type UserListRequest added in v1.0.1

type UserListRequest struct {
}

type UserListResponse added in v1.0.1

type UserListResponse struct {
	Items []string `json:"items"`
}

type UserRemoveRequest added in v1.0.1

type UserRemoveRequest struct {
	UserName string `json:"user_name"`
}

type UserRemoveResponse added in v1.0.1

type UserRemoveResponse struct {
}

type UserSetPasswordRequest added in v1.0.1

type UserSetPasswordRequest struct {
	UserName string `json:"user_name"`
	Password string `json:"password"`
}

type UserSetPasswordResponse added in v1.0.1

type UserSetPasswordResponse struct {
}

Jump to

Keyboard shortcuts

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