README
¶
JDSU CellAdvisor RESTful API
JDSU CellAdvisor API by Go Language
CellAdvisor API
RESTful API Implementation
RESTful API Usage
func main(){
// BuildCellAdvisorRestfulAPI functions get argumets
// 1. The number of TCP connections for API
// 2. CellAdvisor IP
// 3. Heartbeat cheking period
// for example,
server := restful.NewCellAdvisorServer(4, "192.168.0.1", time.Second*10)
http.Handle("/api/", server)
log.Fatal(http.ListenAndServe(":80", nil))
// Now you could access
// SCPI command: http://{celladvisorIP}:{port}/api/scpi/{keyp|youch}
// Screen capture http://{celladvisorIP}:{port}/api/screen/{refresh_screen|screen}
}
Maintainer
License
MIT
Documentation
¶
Overview ¶
Package cell provides api connections between JDSU CellAdvisor Devices
Index ¶
- Variables
- type CellAdvisor
- func (cl CellAdvisor) GetInterferencePower() (*InterferencePower, error)
- func (cl CellAdvisor) GetMessage() ([]byte, error)
- func (cl CellAdvisor) GetScreen() ([]byte, error)
- func (cl CellAdvisor) GetStatusMessage() (string, error)
- func (cl *CellAdvisor) Reinitialize()
- func (cl CellAdvisor) SendMessage(cmd byte, data string) (int, error)
- func (cl CellAdvisor) SendSCPI(scpicmd string) (int, error)
- type InterferencePower
Constants ¶
This section is empty.
Variables ¶
var (
//JDProtocolPort represents Port number which CellAdviosr TCP Connection uses
JDProtocolPort = ":66"
)
Functions ¶
This section is empty.
Types ¶
type CellAdvisor ¶
type CellAdvisor struct {
// contains filtered or unexported fields
}
CellAdvisor represents connection status with JDSU CellAdvisor devices It could only made by NewCellAdvisor(ip string) function
func NewCellAdvisor ¶
func NewCellAdvisor(ip string) CellAdvisor
NewCellAdvisor creates new CellAdvior object with given ip address
func (CellAdvisor) GetInterferencePower ¶
func (cl CellAdvisor) GetInterferencePower() (*InterferencePower, error)
GetInterferencePower returning current interference power array with json format
func (CellAdvisor) GetMessage ¶
func (cl CellAdvisor) GetMessage() ([]byte, error)
GetMessage receive data right after it send request with SendMessage it returns the data and followed error if any
func (CellAdvisor) GetScreen ¶
func (cl CellAdvisor) GetScreen() ([]byte, error)
GetScreen returning current devices jpeg screenshot
func (CellAdvisor) GetStatusMessage ¶
func (cl CellAdvisor) GetStatusMessage() (string, error)
GetStatusMessage returning a heartbeat signal message from CellAdvisor
func (*CellAdvisor) Reinitialize ¶
func (cl *CellAdvisor) Reinitialize()
func (CellAdvisor) SendMessage ¶
func (cl CellAdvisor) SendMessage(cmd byte, data string) (int, error)
SendMessage send single cmd byte, and data strings and returing the number of bytes send and followed error if any
func (CellAdvisor) SendSCPI ¶
func (cl CellAdvisor) SendSCPI(scpicmd string) (int, error)
SendSCPI sends SCPI commands to CellAdvisor devices (http://en.wikipedia.org/wiki/Standard_Commands_for_Programmable_Instruments)
type InterferencePower ¶
type InterferencePower struct {
// Unit represents real unit of following float array
Unit string `json:"Unit"`
// PowerTrace is measured power array based on frequency plan
Powertrace []float32 `json:"Powertrace"`
}
InterferencePower represents interferences data given by CellAdvisor
Source Files
Directories