Compare commits

..
4 Commits
Author SHA1 Message Date
Yurii 61b089fe55 updated workflow for TLJ locks 2025-08-08 11:34:02 +01:00
Yurii 8b0e7df582 improved error handling and logging in Salto 2025-08-01 15:18:38 +01:00
Yurii 25eab0dc75 added check if the room exists 2025-07-25 17:36:08 +01:00
Yurii fc91f2c0f2 updated workflow for Salto locks 2025-07-25 14:32:30 +01:00
5 changed files with 268 additions and 89 deletions
+17 -9
View File
@@ -24,6 +24,12 @@ const (
AssaAbloy = "assaabloy" AssaAbloy = "assaabloy"
Omnitec = "omnitec" Omnitec = "omnitec"
Salto = "salto" Salto = "salto"
TLJ = "tlj"
)
var (
Cert string
LockServerURL string
) )
type ( type (
@@ -34,28 +40,35 @@ type (
AssaLockServer struct { AssaLockServer struct {
encoderAddr string encoderAddr string
command string command string
} }
OmniLockServer struct { OmniLockServer struct {
encoderAddr string // Encoder unit address encoderAddr string // Encoder unit address
command []byte // Command to be sent to the lock server command []byte // Command to be sent to the lock server
} }
SaltoLockServer struct { SaltoLockServer struct {
encoderAddr string encoderAddr string
command []byte command []byte
}
TLJLockServer struct {
encoderAddr string
command string
} }
) )
func NewLockServer(lockType, encoderAddr string, fatalError func(error)) LockServer { func NewLockServer(lockType, encoderAddr string, fatalError func(error)) LockServer {
switch lockType { switch strings.ToLower(lockType) {
case AssaAbloy: case AssaAbloy:
return &AssaLockServer{encoderAddr: encoderAddr} return &AssaLockServer{encoderAddr: encoderAddr}
case Omnitec: case Omnitec:
return &OmniLockServer{encoderAddr: encoderAddr} return &OmniLockServer{encoderAddr: encoderAddr}
case Salto: case Salto:
return &SaltoLockServer{encoderAddr: encoderAddr} return &SaltoLockServer{encoderAddr: encoderAddr}
case TLJ:
return &TLJLockServer{encoderAddr: encoderAddr}
default: default:
fatalError(fmt.Errorf("unsupported LockType: %s; must be 'assaabloy' or 'omnitec'", lockType)) fatalError(fmt.Errorf("unsupported LockType: %s; must be 'assaabloy' or 'omnitec'", lockType))
return nil // This line will never be reached, but is needed to satisfy the compiler return nil // This line will never be reached, but is needed to satisfy the compiler
@@ -100,8 +113,3 @@ func sendAndReceive(conn net.Conn, command []byte) (string, error) {
response := buf[:n] response := buf[:n]
return string(response), nil return string(response), nil
} }
+149 -68
View File
@@ -1,113 +1,194 @@
package lockserver package lockserver
import ( import (
"bufio"
"fmt" "fmt"
"net" "net"
"time" "time"
// "strings"
log "github.com/sirupsen/logrus" log "github.com/sirupsen/logrus"
) )
const ( const (
STX = 0x02 // Start of Text STX = 0x02 // Start of Text
ETX = 0x03 // End of Text ETX = 0x03 // End of Text
ENQ = 0x05 // Enquiry from host ENQ = 0x05 // Enquiry from host
ACK = 0x06 // Positive response ACK = 0x06 // Positive response
NAK = 0x15 // Negative response NAK = 0x15 // Negative response
separator = 0xB3 // '│' character in ASCII (179 decimal)
) )
// calculateLRC computes the Longitudinal Redundancy Check over data
func calculateLRC(data []byte) byte { func calculateLRC(data []byte) byte {
lrc := byte(0x00) var lrc byte
for _, b := range data { for _, b := range data {
lrc ^= b lrc ^= b
} }
return lrc return lrc
} }
// simple join that avoids importing strings just for this. // BuildCommand assembles the SALTO frame with fields #0–#10, STX/ETX and LRC
func stringJoin(parts []string, sep string) string { func (lock *SaltoLockServer) BuildCommand(req DoorCardRequest, checkIn, checkOut time.Time) error {
if len(parts) == 0 { // helper: hh[mm]DDMMYY
return ""
}
out := parts[0]
for _, p := range parts[1:] {
out += sep + p
}
return out
}
// BuildCommand builds a Salto card‑issuance command in the form:
// STX|CN|<encoder addres>|E|<room>| | | | | |<start>|<expiry>|ETX|<LRC>
// where <start> and <expiry> are hhmmDDMMYY, and LRC is the XOR of all bytes
func (lock *SaltoLockServer) BuildCommand(doorReq DoorCardRequest, checkIn, checkOut time.Time) error {
// format helper: hhmmDDMMYY
var command string
fmtStamp := func(t time.Time) string { fmtStamp := func(t time.Time) string {
return fmt.Sprintf("%02d%02d%02d%02d%02d", return fmt.Sprintf("%02d%02d%02d%02d%02d",
t.Hour(), t.Minute(), t.Day(), int(t.Month()), t.Year()%100) t.Hour(), t.Minute(), t.Day(), int(t.Month()), t.Year()%100)
} }
start := fmtStamp(checkIn) start := fmtStamp(checkIn)
expiry := fmtStamp(checkOut) expiry := fmtStamp(checkOut)
switch doorReq.FollowStr { // command type
case "0": cmd := "CN"
command = "CN" // encode keycard if req.FollowStr == "1" {
case "1": cmd = "CC"
command = "CC" // encode keycard copy
default:
command = "CN"
} }
// the 12 fields between STX and ETX // fields 0–10
fields := []string{ fields := []string{
command, lock.encoderAddr, "E", doorReq.RoomField, "", "", "", "", "", "", start, expiry, cmd,
lock.encoderAddr,
"E",
req.RoomField,
"", // optional field 4
"", // 5
"", // 6
"", // 7
"", // 8
start,
expiry,
} }
body := "|" + stringJoin(fields, "|") + "|" // leading/trailing pipes, so the ETX ends the last field // build payload between STX and ETX
body := []byte{STX}
for _, f := range fields {
body = append(body, separator)
body = append(body, []byte(f)...)
}
body = append(body, separator)
body = append(body, ETX)
// wrap with STX/ETX // append LRC (XOR of everything after STX through ETX)
msg := append([]byte{STX}, []byte(body)...) lrc := calculateLRC(body[1:])
msg = append(msg, ETX) body = append(body, lrc)
// compute LRC over everything *after* STX up to and including ETX lock.command = body
lrc := calculateLRC(msg[1:]) // skip STX
msg = append(msg, lrc)
lock.command = msg
return nil return nil
} }
// Checks heart beat of the Assa Abloy lock server and perform key encoding // LockSequence performs the full ENQ/ACK handshake and command exchange
func (lock *SaltoLockServer) LockSequence(conn net.Conn) error { func (lock *SaltoLockServer) LockSequence(conn net.Conn) error {
const funcName = "SaltoLockServer.LockSequence" log.Infof("Sending command: %q", string(lock.command))
// Step 1: ENQ to check availability const timeout = 10 * time.Second
respStr, err := sendAndReceive(conn, []byte{ENQ}) var (
if err != nil { err error
return fmt.Errorf("[%s] failed sending ENQ: %w", funcName, err) resp []byte
} )
resp := []byte(respStr) reader := bufio.NewReader(conn)
if len(resp) != 1 || resp[0] != ACK { // 1. Send ENQ
return fmt.Errorf("[%s] expected ACK (0x06) after ENQ, got: %q (hex: % X)", funcName, respStr, resp) if _, e := conn.Write([]byte{ENQ}); e != nil {
return fmt.Errorf("failed to send ENQ: %w", e)
} }
// Step 2: Send actual command // 2. Expect ACK
respStr, err = sendAndReceive(conn, lock.command) conn.SetReadDeadline(time.Now().Add(timeout))
if err != nil { if b, e := reader.ReadByte(); e != nil {
return fmt.Errorf("[%s] failed sending command: %w", funcName, err) return fmt.Errorf("error awaiting ACK to ENQ: %w", e)
} } else if b != ACK {
resp = []byte(respStr) return fmt.Errorf("expected ACK after ENQ, got 0x%X", b)
if len(resp) == 1 && resp[0] == NAK {
return fmt.Errorf("[%s] command rejected by lock server (NAK)", funcName)
} }
log.Infof("Encoding response: %q", respStr) // 3. Send command frame
return nil if _, e := conn.Write(lock.command); e != nil {
return fmt.Errorf("failed to send command frame: %w", e)
}
// 4. Expect ACK to command
conn.SetReadDeadline(time.Now().Add(timeout))
if b, e := reader.ReadByte(); e != nil {
return fmt.Errorf("error awaiting ACK to command: %w", e)
} else if b == NAK {
return fmt.Errorf("command rejected (NAK)")
} else if b != ACK {
return fmt.Errorf("expected ACK to command, got 0x%X", b)
}
// 5. Expect STX
conn.SetReadDeadline(time.Now().Add(timeout))
stx, e := reader.ReadByte()
if e != nil {
return fmt.Errorf("error reading STX: %w", e)
}
resp = append(resp, stx)
if stx != STX {
err = fmt.Errorf("expected STX, got 0x%X", stx)
}
// 6. Read separator after STX
conn.SetReadDeadline(time.Now().Add(timeout))
if sep, e := reader.ReadByte(); e == nil {
resp = append(resp, sep)
} else if err == nil {
err = fmt.Errorf("error reading separator after STX: %w", e)
}
// 7. Read command code (e.g., CN, TD)
conn.SetReadDeadline(time.Now().Add(timeout))
b1, e1 := reader.ReadByte()
if e1 == nil {
resp = append(resp, b1)
} else if err == nil {
err = fmt.Errorf("error reading first response byte: %w", e1)
}
b2, e2 := reader.ReadByte()
if e2 == nil {
resp = append(resp, b2)
} else if err == nil {
err = fmt.Errorf("error reading second response byte: %w", e2)
}
switch {
case b1 == 'C' && b2 == 'N':
log.Infof("LockSequence: command response is CN (normal)")
case b1 == 'C' && b2 == 'C':
log.Infof("LockSequence: command response is CC (follow-up)")
case b1 == 'T' && b2 == 'D':
log.Warnf("LockSequence: command response is TD (room does not exist)")
if err == nil {
err = fmt.Errorf("lock response indicates room does not exist")
}
default:
log.Warnf("LockSequence: unexpected command response %q", string(resp))
if err == nil {
err = fmt.Errorf("error encoding keycard, unexpected response")
}
}
// 8. Read rest of message until ETX
for {
conn.SetReadDeadline(time.Now().Add(timeout))
c, e := reader.ReadByte()
if e != nil {
if err == nil {
err = fmt.Errorf("error reading response body: %w", e)
}
break
}
resp = append(resp, c)
if c == ETX {
break
}
}
// 9. Optional: read trailing byte (LRC or CR)
conn.SetReadDeadline(time.Now().Add(timeout))
if lrc, e := reader.ReadByte(); e == nil {
resp = append(resp, lrc)
} else {
log.Warnf("LockSequence: failed to read trailing LRC/CR: %v", e)
}
log.Infof("LockSequence: received response: %q", string(resp))
return err
} }
+70
View File
@@ -0,0 +1,70 @@
package lockserver
import (
"encoding/json"
"fmt"
"io/ioutil"
"net"
"net/http"
"net/url"
"time"
log "github.com/sirupsen/logrus"
)
// GuestCardResponse represents the JSON response from the GuestCard API call.
type GuestCardResponse struct {
Code string `json:"code"`
CardID string `json:"CardID"`
CommandID int `json:"CommandID"` // optional
Msg string `json:"Msg"` // error message if Code != "0"
}
func (lock *TLJLockServer) BuildCommand(doorReq DoorCardRequest, checkIn, checkOut time.Time) error {
params := url.Values{}
params.Set("cer", Cert)
params.Set("room", doorReq.RoomField)
params.Set("BeginTime", checkIn.Format("2006-01-02 15:04:05"))
params.Set("EndTime", checkOut.Format("2006-01-02 15:04:05"))
switch doorReq.FollowStr {
case "0":
params.Set("CheckInMode", "new")
case "1":
params.Set("CheckInMode", "follow")
}
lock.command = fmt.Sprintf("%s/GuestCard?%s", LockServerURL, params.Encode())
return nil
}
func (lock *TLJLockServer) LockSequence(conn net.Conn) error {
client := &http.Client{Timeout: 10 * time.Second}
resp, err := client.Get(lock.command)
if err != nil {
return fmt.Errorf("HTTP request failed: %v", err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return fmt.Errorf("unexpected HTTP status: %s", resp.Status)
}
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return fmt.Errorf("failed to read response: %v", err)
}
// Parse response JSON
var result GuestCardResponse
err = json.Unmarshal(body, &result)
if err != nil {
return fmt.Errorf("invalid JSON response: %v", err)
}
if result.Code != "0" {
log.Printf("API error %s: %s", result.Code, result.Msg)
return fmt.Errorf("API error %s: %s", result.Code, result.Msg)
}
log.Printf("Guest card created successfully: CardID=%s, CommandID=%d", result.CardID, result.CommandID)
return nil
}
+18 -10
View File
@@ -30,7 +30,7 @@ import (
) )
const ( const (
buildVersion = "1.0.5" buildVersion = "1.0.9"
serviceName = "hardlink" serviceName = "hardlink"
customLayout = "2006-01-02 15:04:05 -0700" customLayout = "2006-01-02 15:04:05 -0700"
transactionUrl = "http://127.0.0.1:18181/start-transaction/" transactionUrl = "http://127.0.0.1:18181/start-transaction/"
@@ -42,14 +42,14 @@ type configRec struct {
LockserverUrl string `yaml:"lockservUrl"` LockserverUrl string `yaml:"lockservUrl"`
LockType string `yaml:"lockType"` LockType string `yaml:"lockType"`
EncoderAddress string `yaml:"encoderAddr"` EncoderAddress string `yaml:"encoderAddr"`
Cert string `yaml:"cert"`
DispenserPort string `yaml:"dispensPort"` DispenserPort string `yaml:"dispensPort"`
DispenserAdrr string `yaml:"dispensAddr"` DispenserAdrr string `yaml:"dispensAddr"`
PrinterName string `yaml:"printerName"` PrinterName string `yaml:"printerName"`
LogDir string `yaml:"logdir"` LogDir string `yaml:"logdir"`
isPayment bool `yaml:"isPayment"` IsPayment bool `yaml:"isPayment"`
} }
// App holds shared resources. // App holds shared resources.
type App struct { type App struct {
dispPort *serial.Port dispPort *serial.Port
@@ -68,10 +68,13 @@ func newApp(dispPort *serial.Port, lockConn net.Conn, config configRec) *App {
func main() { func main() {
// Load config // Load config
config := readConfig() config := readConfig()
printer.Layout = readTicketLayout() printer.Layout = readTicketLayout()
printer.PrinterName = config.PrinterName printer.PrinterName = config.PrinterName
var lockConn net.Conn
lockserver.Cert = config.Cert
lockserver.LockServerURL = config.LockserverUrl
// Setup logging and get file handle // Setup logging and get file handle
logFile, err := setupLogging(config.LogDir) logFile, err := setupLogging(config.LogDir)
if err != nil { if err != nil {
@@ -101,12 +104,17 @@ func main() {
log.Infof("Dispenser initialized on port %s, %s", config.DispenserPort, status) log.Infof("Dispenser initialized on port %s, %s", config.DispenserPort, status)
// Initialize lock-server connection once // Initialize lock-server connection once
lockConn, err := lockserver.InitializeServerConnection(config.LockserverUrl) switch strings.ToLower(config.LockType) {
if err != nil { case lockserver.TLJ:
fatalError(err)
default:
lockConn, err = lockserver.InitializeServerConnection(config.LockserverUrl)
if err != nil {
fatalError(err)
}
defer lockConn.Close()
log.Infof("Connected to lock server at %s", config.LockserverUrl)
} }
defer lockConn.Close()
log.Infof("Connected to lock server at %s", config.LockserverUrl)
// db, err := payment.InitMSSQL(config.dbport, config.dbname, config.dbuser, config.dbpassword) // db, err := payment.InitMSSQL(config.dbport, config.dbname, config.dbuser, config.dbpassword)
// if err != nil { // if err != nil {
@@ -114,7 +122,7 @@ func main() {
// } // }
// defer db.Close() // defer db.Close()
if config.isPayment { if config.IsPayment {
startClient := func() (*exec.Cmd, error) { startClient := func() (*exec.Cmd, error) {
cmd := exec.Command("./ChipDNAClient/ChipDnaClient.exe") cmd := exec.Command("./ChipDNAClient/ChipDnaClient.exe")
err := cmd.Start() err := cmd.Start()
+12
View File
@@ -2,6 +2,18 @@
builtVersion is a const in main.go builtVersion is a const in main.go
#### 1.0.9 - 08 August 2024
updated workflow for TLJ locks
#### 1.0.8 - 01 August 2024
improved error handling and logging in Salto
#### 1.0.7 - 25 July 2024
added check if the room exists
#### 1.0.6 - 25 July 2024
updated workflow for Salto locks
#### 1.0.5 - 24 July 2024 #### 1.0.5 - 24 July 2024
added encoding keycard copy for Salto locks added encoding keycard copy for Salto locks