server

Documentation

Index

• Constants
• func ConnectNhc(cfg *config.NhcConf) (conn *net.TCPConn, err error)
• func CreateJeedomCMD(cmd interface{}) (i string, err error)
• func CreateJeedomEquipment(locID, name string) (i string, err error)
• func CreateJeedomObject(name string) error
• func Discover() net.IP
• func ExecJeedomRPCRequest(args *types.JsonRpcArgs) (res []byte, err error)
• func GetJeedomCMDs(id string) []types.JeedomCMD
• func GetJeedomEquipments() []types.JeedomEquipment
• func GetJeedomObjects() []types.JeedomLocation
• func GetNhcInfo(w http.ResponseWriter, r *http.Request)
• func GetNhcItem(w http.ResponseWriter, r *http.Request)
• func GetNhcItems(w http.ResponseWriter, r *http.Request)
• func GetOutboundIP() net.IP
• func Health(w http.ResponseWriter, r *http.Request)
• func JeedomCmd(w http.ResponseWriter, r *http.Request)
• func JeedomInit()
• func NhcCmd(w http.ResponseWriter, r *http.Request)
• func NhcInit(cfg *config.NhcConf)
• func NhcListener()
• func Route(msg *types.Message)
• func SendCommand(cmd string) error
• func ServeWebSocket(w http.ResponseWriter, r *http.Request)
• func Start(conf string)
• func UpdateJeedomState(item types.NHCItem) error
• type ClientPool
  • func (cp *ClientPool) Run()
• type Server
  • func (s *Server) Initialize()
  • func (s *Server) Run()
• type SimpleCmd
  • func (sc SimpleCmd) Stringify() string
• type WSClient

Constants

const (
	// SystemInfo holds NHC startevents
	SystemInfo = "{\"cmd\":\"systeminfo\"}"
	// RegisterCMD holds NHC startevents
	RegisterCMD = "{\"cmd\":\"startevents\"}"
	// ListActions holds NHC listactions
	ListActions = "{\"cmd\":\"listactions\"}"
	// ListLocations holds NHC listlocations
	ListLocations = "{\"cmd\":\"listlocations\"}"
	// ListEnergies holds NHC listenergy
	ListEnergies = "{\"cmd\":\"listenergy\"}"
	// ListThermostats holds NHC listthermostat
	ListThermostats = "{\"cmd\":\"listthermostat\"}"
)

const HealthMsg = `{"alive":true}`

HealthMsg static alive json for health endpoint

Functions

func ConnectNhc

func ConnectNhc(cfg *config.NhcConf) (conn *net.TCPConn, err error)

ConnectNhc establish connection to Niko Home Control IP module

func CreateJeedomCMD

func CreateJeedomCMD(cmd interface{}) (i string, err error)

CreateJeedomCMD creates a cmd to a Jeedom script equipment

func CreateJeedomEquipment

func CreateJeedomEquipment(locID, name string) (i string, err error)

CreateJeedomEquipment saves a new script equipment to jeedom

func CreateJeedomObject

func CreateJeedomObject(name string) error

CreateJeedomObject saves the object to jeedom (location)

func Discover

func Discover() net.IP

Discover discover NHC controller by sending UDP pkg on port 10000 return NHC IP address and boolean

func ExecJeedomRPCRequest

func ExecJeedomRPCRequest(args *types.JsonRpcArgs) (res []byte, err error)

ExecJeedomRPCRequest send JSON RPC request to Jeedom, returns raw result

func GetJeedomCMDs

func GetJeedomCMDs(id string) []types.JeedomCMD

GetJeedomCMDs returns the list of cmds of a given equipment

func GetJeedomEquipments

func GetJeedomEquipments() []types.JeedomEquipment

GetJeedomEquipments list all Jeedom script equipments

func GetJeedomObjects

func GetJeedomObjects() []types.JeedomLocation

GetJeedomObjects gets all objects from Jeedom

func GetNhcInfo

func GetNhcInfo(w http.ResponseWriter, r *http.Request)

GetNhcInfo handler for /api/v1/nhc/

func GetNhcItem

func GetNhcItem(w http.ResponseWriter, r *http.Request)

GetNhcItem handler for /api/v1/nhc/{id}

func GetNhcItems

func GetNhcItems(w http.ResponseWriter, r *http.Request)

GetNhcItems handler for /api/v1/nhc/

func GetOutboundIP

func GetOutboundIP() net.IP

GetOutboundIP returns the IP address used for out access

func Health

func Health(w http.ResponseWriter, r *http.Request)

Health endpoint for health monitoring

func JeedomCmd

func JeedomCmd(w http.ResponseWriter, r *http.Request)

JeedomCmd handler for POST on /jeedom/{id}/{value}

func JeedomInit

func JeedomInit()

JeedomInit Initialize jeedom internal "db"

func NhcCmd

func NhcCmd(w http.ResponseWriter, r *http.Request)

NhcCmd endpoints for sending NHC commands

func NhcInit

func NhcInit(cfg *config.NhcConf)

NhcInit sends list commands to NHC in order to get all equipments

func NhcListener

func NhcListener()

NhcListener start a connection to nhc host, register itself to receive and route all messages from nhc broadcast

func Route

func Route(msg *types.Message)

Route parse and route incoming message the right handler

func SendCommand

func SendCommand(cmd string) error

SendCommand send passed command to nhc

func ServeWebSocket

func ServeWebSocket(w http.ResponseWriter, r *http.Request)

ServeWebSocket called by the http endpoint. Calls serveWS function and adds the WSPool to original connection

func Start

func Start(conf string)

Start Initialize and start the server

func UpdateJeedomState

func UpdateJeedomState(item types.NHCItem) error

UpdateJeedomState updates the device's status in Jeedom

Types

type ClientPool

type ClientPool struct {

	// Broadcast Inbound messages from the clients.
	Broadcast chan []byte

	// Unregister requests from clients.
	Unregister chan *WSClient
	// contains filtered or unexported fields
}

ClientPool maintains the set of active clients and broadcasts messages to the clients. Use the Broadcast channel to push msg to all clients

var (

	// WSPool instance to hold ClientPool
	WSPool *ClientPool
)

func (*ClientPool) Run

func (cp *ClientPool) Run()

Run activates the ClientPool so that we can manage client connections

type Server

type Server struct {
	Router     *mux.Router
	ListenPort string
	LogLevel   string
	LogFile    string
}

Server holds the gomotics app definition

func (*Server) Initialize

func (s *Server) Initialize()

Initialize initialize the server also calls the internal in mem db

func (*Server) Run

func (s *Server) Run()

Run starts the server process

type SimpleCmd

type SimpleCmd struct {
	Cmd   string `json:"cmd"`
	ID    int    `json:"id"`
	Value int    `json:"value1"`
}

SimpleCmd type holding a nhc command

func (SimpleCmd) Stringify

func (sc SimpleCmd) Stringify() string

Stringify return the string version of SimpleCmd

type WSClient

type WSClient struct {
	// contains filtered or unexported fields
}

WSClient handles the ws client conn. use send channel as input for pushing msg to client