TCPSocket Debugging

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
--Debug flags
DebugTx, DebugRx, DebugFunction = true, true, true

-- Connection Variables
IPAddress = "192.168.1.1"
Port = 10001

-- Sockets
TCP = TcpSocket.New()    -- Create new TcpSocket object
TCP.ReadTimeout = 5      -- Set the timeout to 5 seconds
TCP.WriteTimeout = 5     -- Set the timeout to 5 seconds
TCP.ReconnectTimeout = 5 -- Set the wait time bfore reconnecting

-- Functions
-- Helper Functions
-- Connect the TCP socket to the address
function Connect()
  if DebugFunction then print("Connect() called") end
  TCP:Connect( IPAddress, Port )
end

-- Returns true if TCP Socket is connected
function IsConnected()
  if DebugFunction then print("IsConnect() called") end
  return TCP.IsConnected
end

-- When TCPSocket is successfully connected
function Connected()
  if DebugFunction then print("Connected() called") end
  -- On connect functionality
end

-- When the TCPSocket loses connection
function Disconnected()
  if DebugFunction then print("Disconnected() called") end
  -- On disconnect functionality
end

-- TCP socket callbacks
-- Called when TCP socket is connected
TCP.Connected=function(socket)
  if DebugFunction then print("TCP Socket Connect handler called") end
  Connected()
end

-- Called when TCP socket is reconnecting
TCP.Reconnect=function(socket)
  if DebugFunction then print("TCP Socket Reconnect handler called") end
  Disconnected()
end

-- Called when TCP socket is closed
TCP.Closed=function(socket)
  if DebugFunction then print("TCP Socket Closed handler called") end
  Disconnected()
end

-- Called when TCP socket has an error
TCP.Error=function(socket, err)
  if DebugFunction then print("TCP Socket Error handler called: " .. err) end
  Disconnected()
end

-- Called when TCP socket times out
TCP.Timeout=function(socket)
  if DebugFunction then print("TCP Socket Timeout handler called") end
  Disconnected()
end

-- Called when the TCPSocket receives data from remote device
TCP.Data = function(socket)
  if DebugFunction then print("TCP Socket Data handler called") end
  ParseResponse()  -- Call ParseResponse when the TCP socket has data
end

-- Use the TCPSocket to send cmd to the remote device
function Send(cmd)  
  if DebugFunction then print("Send() called") end
  if TCP.IsConnected then   -- If the TCP socket is connected write the command and EOL to the socket
    if DebugTx then print("TX: " .. cmd) end
    TCP:Write(cmd) 
  else
    print("Error - Disconnected; unable to send " .. cmd .. EOL)
  end
end

--Parsers
-- Pull the data from the TCPSocket and parse/use it
function ParseResponse()
  if DebugFunction then print("ParseResponse() called") end
  local rx = TCP:Read(TCP.BufferLength)  -- Read the data in the buffer
  if DebugRx then print("RX: " .. rx) end

  -- Add data handling routines here

end

-- Run at start
Connect()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
function GetProperties()
  props = {}
  table.insert(props, {
    Name = "Debug Print",
    Type = "enum",
    Choices = {"None", "Tx/Rx", "Tx", "Rx", "Function Calls", "All"},
    Value = "None"
  })
  return props
end

--Within the runtime add:
-- Debugging level
DebugTx,DebugRx,DebugFunction = false, false, false
DebugPrint = Properties["Debug Print"].Value
if DebugPrint == "Tx/Rx" then
  DebugTx, DebugRx = true, true
elseif DebugPrint == "Tx" then
  DebugTx = true
elseif DebugPrint == "Rx" then
  DebugRx = true
elseif DebugPrint == "Function Calls" then
  DebugFunction = true
elseif DebugPrint == "All" then
  DebugTx, DebugRx, DebugFunction = true, true, true
end

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
--Initializing
--Aliases
button_connect = Controls.Connect
address = Controls["IP Address"]
port = Controls.Port

--Variables
TestCommand = "Hello, World!\n"

--Objects
sock = TcpSocket.New()
sock.ReadTimeout = 0
sock.WriteTimeout = 0
sock.ReconnectTimeout = 5

--Control Functions

sock.Connected = function(sock)
  print("TCP socket is connected")
  button_connect.Color = "green"
end

sock.Reconnect = function(sock)
  print("TCP socket is reconnecting")
end

sock.Data = function(sock)
  print("TCP socket has data:", sock:Read(sock.BufferLength) )
end

sock.Closed = function(sock)
  print("TCP socket was closed by the remote end")
  button_connect.Color = "red"
end

sock.Error = function(sock, err)
  print("TCP socket had an error:", err)
end

sock.Timeout = function(sock, err)
  print("TCP socket timed out", err)
end

function send(cmd)
  print("Sending: ", cmd)
  sock:Write(cmd)
end

Controls["Connect"].EventHandler = function()
  print(address.String, port.String)
  sock:Connect(address.String, tonumber(port.String) )
  button_connect.Color = "yellow"
end

Controls['Test Command'].EventHandler = function()
  send(TestCommand)
end

button_connect.Color = "red"