Documentation
¶
Overview ¶
Package fancoil communicates with a Heat Transfer Products (and presumably Chiltrix) fan coil unit.
The fan coil unit manual: https://htproducts.com/literature/lp-587.pdf
The Chiltrix and HTP fan coil units are manufactured by the same Chinese company. This package should work for any fan coil unit with a ZLFP10 circuit board; it will not work with the older MD1001 circuit board. HTP seems to ship units with both circuit boards, and according to one technical support representative the boards are not interchangable.
The modbus functionality is not officially supported by HTP. The documentation from the manual is incomplete but still useful.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GRPCServiceFromClient ¶
func GRPCServiceFromClient(c *Client) pb.FanCoilServiceServer
GRPCServiceFromClient returns an implementation of FanCoilServiceServer using a *Client object.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is used to communicate with the Chiltrix CX34 heat pump.
func (*Client) CheckConnection ¶
CheckConnection attempts to connect to the heat pump and returns an error if the connection fails.
func (*Client) Close ¶
Close closes the modbus connection and frees up resources associated with the client.
func (*Client) GetState ¶
func (c *Client) GetState(_ context.Context, req *pb.GetStateRequest) (*pb.GetStateResponse, error)
GetState returns a snapshot of the state of a single fan coil unit.
type Mode ¶
type Mode string
Mode indicates the protocol that should be used to communicate with the CX34.
type Params ¶
type Params struct {
// The /dev/ttyX device shown by dmesg for the RS-485 connection to the heat pump.
TTYDevice string
Mode Mode
}
Params configures the connection to the Chiltrix.
type State ¶
type State struct {
// contains filtered or unexported fields
}
State is a snapshot of the heat pump's state.
func StateFromSnapshotProto ¶
StateFromSnapshotProto converts a state proto into a State object.
func (*State) CollectionTime ¶
CollectionTime returns the collection time of the heat pump state log entry.
func (*State) RegisterValues ¶
RegisterValues returns a map of register values. The map should not be modified by the caller.
func (*State) ResponseProto ¶
func (s *State) ResponseProto() *pb.GetStateResponse
ResponseProto returns the protobuf form of state.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
fancoil_status
Program fancoil_status prints out the status of any connected fan coil.
|
Program fancoil_status prints out the status of any connected fan coil. |