vc

package

Go to main page

Versions in this module

v0

v0.1.0

Jan 7, 2024

Changes in this version

+ const TOKENREQUEST

+ type ApiToken struct

+ Description string

+ Level string

+ Status TokenStatus

+ Token string

+ type ApitTokenResponse struct

+ Device struct{ ... }

+ type CreateApiTokenRequest struct

+ Description string

+ Status TokenStatus

+ type EditApiTokenRequest struct

+ Description string

+ Status TokenStatus

+ Token string

+ type TokenStatus int

+ const ReadOnlyToken

+ const ReadWriteToken

type VC

+ func (v *VC) CreateToken(readonly bool, description string) (ApiToken, VirtualControlError)

+ func (v *VC) DeleteToken(token string) (bool, VirtualControlError)

+ func (v *VC) EditToken(readonly bool, description string, token string) (ApiToken, VirtualControlError)

+ func (v *VC) GetTokens() ([]ApiToken, VirtualControlError)

+ type VcApiToken interface

+ CreateToken func(readonly bool, description string) (ApiToken, VirtualControlError)

+ DeleteToken func(token string) (bool, VirtualControlError)

+ EditToken func(readonly bool, description string, token string) (ApiToken, VirtualControlError)

+ GetTokens func() ([]ApiToken, VirtualControlError)

v0.0.8

Jan 6, 2024

Changes in this version

+ const IPTABLEBYID

+ type IpTableDevice struct

+ type IpTableEntry struct

+ Description string

+ DeviceID int

+ DeviceType int

+ Hostname string

+ MacAddress string

+ Model string

+ ProgramIPID int

+ ProgramInstanceID string

+ RemoteIP string

+ Status string

+ SupportAssociation bool

+ UniqueID int

+ type IpTablePrograms struct

+ IPTableByPID []IpTableEntry

+ type IpTableResponse struct

type VC

+ func (v *VC) GetIpTable(roomId string) ([]IpTableEntry, VirtualControlError)

+ type VcIpTableApi interface

+ GetIpTable func(roomId string) ([]IpTableEntry, VirtualControlError)

v0.0.7

Dec 30, 2023

v0.0.6

Dec 30, 2023

v0.0.5

Dec 21, 2023

Changes in this version

type VC

+ func (v *VC) CreateAndRunProgram(progOps *ProgramOptions, roomOps *RoomOptions) (result RoomCreatedResult, err VirtualControlError)

type VcProgramApi

+ CreateAndRunProgram func(progOps *ProgramOptions, roomOps *RoomOptions) (result RoomCreatedResult, err VirtualControlError)

v0.0.4

Dec 20, 2023

v0.0.3

Dec 19, 2023

Changes in this version

type ProgramOptions

+ CwsFile string

+ MobilityFile string

+ ProgramId int

+ ProjectFile string

+ StartNow bool

+ WebxPanelFile string

+ type RoomCreatedResult struct

+ Code int

+ Message string

+ Success bool

+ type RoomOptions struct

+ AddressSetsLocation bool

+ Latitude string

+ Level string

+ Location string

+ Longitude string

+ Name string

+ Notes string

+ ProgramInstanceId string

+ ProgramLibraryId int

+ TimeZone string

+ UserFile string

+ func NewRoomOptions(programId int, id string, name string) RoomOptions

type VC

+ func (v *VC) CreateRoom(options RoomOptions) (RoomCreatedResult, VirtualControlError)

+ func (v *VC) DeleteRoom(id string) VirtualControlError

+ func (v *VC) EditProgram(options ProgramOptions) (result ProgramUploadResult, err VirtualControlError)

+ func (v *VC) EditRoom(options RoomOptions) (RoomCreatedResult, VirtualControlError)

type VcProgramApi

+ EditProgram func(options ProgramOptions) (result ProgramUploadResult, err VirtualControlError)

type VcRoomApi

+ CreateRoom func(options RoomOptions) (RoomCreatedResult, VirtualControlError)

+ DeleteRoom func(id string) VirtualControlError

+ EditRoom func(options RoomOptions) (RoomCreatedResult, VirtualControlError)

v0.0.2

Dec 16, 2023

Changes in this version

+ const DEVICEINFO

+ const LOCALHOSTURL

+ const PROGRAMLIBRARY

+ func WithFile(opt *ProgramOptions)

+ type ActionData struct

+ Operation string

+ Results []ActionResponseResult[T]

+ TargetObject string

+ Version string

+ type ActionResponse struct

+ Actions []ActionData[T]

+ type ActionResponseResult struct

+ Object T

+ Path string

+ StatusID int16

+ StatusInfo string

+ type DeviceContext struct

+ DeviceInfo DeviceInfo

+ type DeviceInfo struct

+ ApplicationVersion string

+ BuildDate string

+ Category string

+ DeviceID string

+ DeviceKey string

+ ID string

+ MACAddress string

+ Manufacturer string

+ Model string

+ MonoVersion string

+ Name string

+ PythonVersion string

+ Version string

+ type DeviceInformationResponse struct

+ Device DeviceContext

+ type DeviceProgramInstances struct

+ Programs ProgramInstances

+ type HttpResponseError struct

+ StatusCode int

+ func NewResponseError(code int) *HttpResponseError

+ func (code HttpResponseError) Error() string

+ type LibraryContext struct

+ Programs ProgramsContext

+ type ProgramDeleteResult struct

+ Code int16

+ Result string

+ Success bool

+ func NewProgramDeleteResult(actions *ActionResponse[any]) ProgramDeleteResult

+ type ProgramEntry struct

+ AppFile string

+ AppFileTS string

+ CompileDateTime string

+ CresDBVersion string

+ CwsFile string

+ CwsFileTS string

+ DeviceDBVersion string

+ FriendlyName string

+ IncludeDATVersion string

+ MobilityFile string

+ MobilityFileTS string

+ Notes string

+ ProgramID int16

+ ProgramName string

+ ProgramType string

+ ProjectFile string

+ ProjectFileTS string

+ WebxPanelFile string

+ WebxPanelFileTS string

+ type ProgramInstance struct

+ AddressSetsLocation bool

+ ConfigurationLink string

+ DebuggingEnabled bool

+ ID int64

+ Latitude string

+ Level string

+ Location string

+ Longitude string

+ Name string

+ Notes string

+ ProgramInstanceID string

+ ProgramLibraryID int

+ Status string

+ TimeZone string

+ UserFile string

+ XpanelURL string

+ type ProgramInstanceLibrary map[string]ProgramInstance

+ type ProgramInstanceResponse struct

+ Device DeviceProgramInstances

+ type ProgramInstances struct

+ ProgramInstanceLibrary ProgramInstanceLibrary

+ type ProgramLibraryResponse struct

+ Device LibraryContext

+ type ProgramOptions struct

+ AppFile string

+ Name string

+ Notes string

+ type ProgramOptsFunc func(*ProgramOptions)

+ type ProgramUploadResult struct

+ Code int16

+ FriendlyName string

+ ProgramID int16

+ Result string

+ Success bool

+ func NewProgramUploadResult(actions *ActionResponse[ProgramEntry]) ProgramUploadResult

+ type Programs []ProgramEntry

+ type ProgramsContext struct

+ ProgramLibrary ProgramsLibrary

+ type ProgramsLibrary map[string]ProgramEntry

+ type Room struct

+ CompileDateTime string

+ ConfigurationLink string

+ Debugging bool

+ ID string

+ Latitude string

+ Location string

+ Longitude string

+ Name string

+ Notes string

+ ProgramFriendly string

+ ProgramID int16

+ ProgramName string

+ ProgramType string

+ Status string

+ TimeZone string

+ XpanelURL string

+ func NewRoom(i ProgramInstance, p ProgramEntry) Room

+ type RoomStatus string

+ const Aborted

+ const PROGRAMINSTANCES

+ const Running

+ const Starting

+ const Stopped

+ const Stopping

+ type Rooms []Room

+ type ServerError struct

+ func NewServerError(code int, err error) *ServerError

+ func (e *ServerError) Error() string

+ type VC struct

+ func (v *VC) Config() *VirtualConfig

+ func (v *VC) CreateProgram(options ProgramOptions) (result ProgramUploadResult, err VirtualControlError)

+ func (v *VC) DebugRoom(id string, enable bool) (bool, VirtualControlError)

+ func (v *VC) DeleteProgram(id int) (result ProgramDeleteResult, err VirtualControlError)

+ func (v *VC) DeviceInfo() (DeviceInfo, VirtualControlError)

+ func (v *VC) GetPrograms() (Programs, VirtualControlError)

+ func (v *VC) GetRooms() (Rooms, VirtualControlError)

+ func (v *VC) RestartRoom(id string) (bool, VirtualControlError)

+ func (v *VC) StartRoom(id string) (bool, VirtualControlError)

+ func (v *VC) StopRoom(id string) (bool, VirtualControlError)

+ type VcInfoApi interface

+ DeviceInfo func() (DeviceInfo, VirtualControlError)

+ type VcProgramApi interface

+ CreateProgram func(options ProgramOptions) (result ProgramUploadResult, err VirtualControlError)

+ DeleteProgram func(id int) (result ProgramDeleteResult, err VirtualControlError)

+ GetPrograms func() (Programs, VirtualControlError)

+ type VcRoomApi interface

+ DebugRoom func(id string, enable bool) (bool, VirtualControlError)

+ GetRooms func() (Rooms, VirtualControlError)

+ RestartRoom func(id string) (bool, VirtualControlError)

+ StartRoom func(id string) (bool, VirtualControlError)

+ StopRoom func(id string) (bool, VirtualControlError)

+ type VirtualConfig struct

+ type VirtualControl interface

+ Config func() *VirtualConfig

+ func NewLocalVC() VirtualControl

+ func NewRemoteVC(host string, token string) VirtualControl

+ type VirtualControlError interface

+ Error func() string

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