requests

Documentation

Index

• type DiscoveryMode
• type DiscoveryParameter
  • func (dp *DiscoveryParameter) String() string
  • func (dp *DiscoveryParameter) Valid() error
• type MulticastParameter
• type NetScanParameter
• type SerialScanParameter
• type UpdateDeviceStatusRequest
  • func NewUpdateDeviceStatusRequest(dto dtos.UpdateDeviceStatus) UpdateDeviceStatusRequest
  • func (d *UpdateDeviceStatusRequest) UnmarshalJSON(b []byte) error
  • func (d *UpdateDeviceStatusRequest) Validate() error

Types

type DiscoveryMode

type DiscoveryMode string

const (
	Multicast  DiscoveryMode = "multicast"
	NetScan    DiscoveryMode = "netscan"
	SerialScan DiscoveryMode = "serialscan"
)

type DiscoveryParameter

type DiscoveryParameter struct {
	DiscoveryMode       DiscoveryMode        `json:"discovery_mode"`
	MaxDurationTime     time.Duration        `json:"max_duration_time"`
	MulticastParameter  *MulticastParameter  `json:"multicast_parameter,omitempty"`
	NetScanParameter    *NetScanParameter    `json:"net_scan_parameter,omitempty"`
	SerialScanParameter *SerialScanParameter `json:"serial_scan_parameter,omitempty"`
	Credentials         map[string]string    `json:"credentials,omitempty"`
}

func (*DiscoveryParameter) String

func (dp *DiscoveryParameter) String() string

func (*DiscoveryParameter) Valid

func (dp *DiscoveryParameter) Valid() error

type MulticastParameter

type MulticastParameter struct {
	// The target ethernet interface for multicast discovering
	EthernetInterface string `json:"ethernet_interface"`
}

MulticastParameter is the input configuration for a Multicast Discovery.

type NetScanParameter

type NetScanParameter struct {
	// Protocol is the type of probe to make: tcp, udp, etc.
	Protocol string `json:"protocol"`
	// List of IPv4 subnets to perform netscan discovery on, in CIDR format (X.X.X.X/Y).
	Subnets []string `json:"subnets"`
	// ScanPorts is a slice of ports to scan for on each host.
	ScanPorts []string `json:"scan_ports"`
	// Maximum simultaneous network probes when running netscan discovery.
	ProbeAsyncLimit int `json:"probe_async_limit"`
	// Maximum amount of milliseconds to wait for each IP probe before timing out.
	ProbeTimeout time.Duration `json:"probe_timeout"`
}

NetScanParameter is the input configuration for a NetScan Discovery.

type SerialScanParameter

type SerialScanParameter struct {
	// The serial port bitrate, e.g. 9600, 19200, ...
	BaudRate int `json:"baud_rate"`
	// Size of the character (must be 5, 6, 7 or 8)
	DataBits int `json:"data_bits"`
	// The serial port stop bits setting (must be 1 or 2)
	StopBits int `json:"stop_bits"`
	// The serial port parity setting (must be none, even or odd)
	Parity string `json:"parity"`
}

SerialScanParameter is the input configuration for a SerialScan Discovery.

type UpdateDeviceStatusRequest

type UpdateDeviceStatusRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Status                dtos.UpdateDeviceStatus `json:"status"`
}

func NewUpdateDeviceStatusRequest

func NewUpdateDeviceStatusRequest(dto dtos.UpdateDeviceStatus) UpdateDeviceStatusRequest

func (*UpdateDeviceStatusRequest) UnmarshalJSON

func (d *UpdateDeviceStatusRequest) UnmarshalJSON(b []byte) error

func (*UpdateDeviceStatusRequest) Validate

func (d *UpdateDeviceStatusRequest) Validate() error