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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
|
/*
RailControl - Model Railway Control Software
Copyright (c) 2017-2025 by Teddy / Dominik Mahrer - www.railcontrol.org
RailControl is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3, or (at your option) any
later version.
RailControl is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with RailControl; see the file LICENCE. If not see
<http://www.gnu.org/licenses/>.
*/
#include <cstring> //memset
#include "DataModel/ObjectIdentifier.h"
#include "Hardware/Protocols/Z21.h"
#include "Manager.h"
#include "Server/Z21/Z21Client.h"
using DataModel::ObjectIdentifier;
namespace Z21Enums = Hardware::Protocols::Z21Enums;
namespace Server { namespace Z21
{
Z21Client::Z21Client(const unsigned int id,
Manager& manager,
const int serverSocket,
const struct sockaddr_storage* clientAddress)
: Network::UdpClient(serverSocket, clientAddress, 60),
logger(Logger::Logger::GetLogger("Z21Client # " + std::to_string(id))),
manager(manager),
broadCastFlags(Z21Enums::BroadCastFlagNone)
{
logger->Debug(Languages::TextUdpConnectionEstablished, AddressAsString());
SendSystemStatusChanged();
}
Z21Client::~Z21Client()
{
logger->Debug(Languages::TextUdpConnectionClosed, AddressAsString());
}
void Z21Client::Work(const unsigned char* buffer, const size_t dataLength)
{
logger->HexIn(buffer, dataLength);
size_t dataRead = 0;
while (dataRead < dataLength)
{
size_t ret = ParseData(buffer + dataRead, dataLength - dataRead);
if (ret == 0)
{
break;
}
dataRead += ret;
}
}
size_t Z21Client::ParseData(const unsigned char* buffer, const size_t bufferLength)
{
unsigned short dataLength = Utils::Integer::DataLittleEndianToShort(buffer);
if (dataLength < 4 || dataLength > bufferLength)
{
return 1472; // 1472 = Max UDP data size
}
const uint16_t header = Utils::Integer::DataLittleEndianToShort(buffer + 2);
switch (header)
{
case Z21Enums::HeaderSerialNumber:
SendSerialNumber();
break;
case Z21Enums::HeaderGetCode:
SendCode();
break;
case Z21Enums::HeaderGetHardwareInfo:
SendHardwareInfo();
break;
case Z21Enums::HeaderLogOff:
Terminate();
break;
case Z21Enums::HeaderSeeXHeader:
ParseXHeader(buffer);
break;
case Z21Enums::HeaderSetBroadcastFlags:
{
broadCastFlags = static_cast<Z21Enums::BroadCastFlags>(Utils::Integer::DataLittleEndianToInt(buffer + 4));
break;
}
case Z21Enums::HeaderGetBroadcastFlags:
SendBroadcastFlags();
break;
case Z21Enums::HeaderGetLocoMode:
{
const uint16_t address = *(reinterpret_cast<const uint16_t*>(buffer + 4));
SendLocoMode(address);
break;
}
case Z21Enums::HeaderSetLocoMode:
// ignore loco mode, we always use DCC
break;
case Z21Enums::HeaderGetTurnoutMode:
{
const uint16_t address = *(reinterpret_cast<const uint16_t*>(buffer + 4));
SendTurnoutMode(address);
break;
}
case Z21Enums::HeaderSetTurnoutMode:
// ignore turnout mode, we always use DCC
break;
case Z21Enums::HeaderGetSystemState:
SendSystemStatusChanged();
break;
default:
SendUnknownCommand();
break;
}
return dataLength;
}
void Z21Client::ParseXHeader(const unsigned char* buffer)
{
Z21Enums::XHeader xHeader = static_cast<Z21Enums::XHeader>(buffer[4]);
switch (xHeader)
{
case Z21Enums::XHeaderSeeDB0_1:
ParseDB0(buffer);
return;
case Z21Enums::XHeaderSetStop:
logger->Debug(Languages::TextBoosterIsTurnedOff);
manager.Booster(ControlTypeZ21Server, BoosterStateStop);
SendBcStopped();
return;
case Z21Enums::XHeaderGetLocoInfo:
{
const Address address = ParseLocoAddress(buffer + 6);
logger->Debug("Address: {0}", address);
const DataModel::LocoBase* const locoBase = manager.GetLocoBase(manager.GetIdentifierOfServerLocoAddress(address));
if (nullptr == locoBase)
{
return;
}
SendLocoInfo(locoBase);
return;
}
case Z21Enums::XHeaderGetTurnoutInfo:
{
const Address address = ParseLocoAddress(buffer + 5);
logger->Debug("Address: {0}", address);
const DataModel::AccessoryBase* const accessoryBase = manager.GetAccessoryBase(manager.GetIdentifierOfServerAccessoryAddress(address));
if (nullptr == accessoryBase)
{
return;
}
SendTurnoutInfo(accessoryBase);
return;
}
case Z21Enums::XHeaderLocoDrive:
switch(buffer[5])
{
case Z21Enums::DB0SetLocoDrive14:
case Z21Enums::DB0SetLocoDrive28:
case Z21Enums::DB0SetLocoDrive128:
case Z21Enums::DB0LocoFunction:
ParseLocoDrive(buffer);
return;
default:
return;
}
case Z21Enums::XHeaderSetLocoBinaryState:
// we do not care
return;
case Z21Enums::XHeaderSetTurnout:
{
const Address address = ParseAccessoryAddress(buffer + 5);
const ObjectIdentifier accessoryBaseIdentifier(manager.GetIdentifierOfServerAccessoryAddress(address));
const bool activate = (buffer[7] & 0x08) == 0x08;
if (!activate)
{
return;
}
const DataModel::AccessoryState state = static_cast<DataModel::AccessoryState>(buffer[7] & 0x01);
logger->Debug(Languages::Languages::TextReceivedAccessoryCommand, Utils::Utils::ProtocolToString(ProtocolDCC), address, state);
manager.AccessoryBaseState(ControlTypeZ21Server, accessoryBaseIdentifier, state);
return;
}
case Z21Enums::XHeaderGetFirmwareVersion:
SendFirmwareVersion();
return;
default:
SendUnknownCommand();
return;
}
}
void Z21Client::ParseDB0(const unsigned char* buffer)
{
switch (buffer[5])
{
case Z21Enums::DB0Version:
SendVersion();
return;
case Z21Enums::DB0Status:
SendStatusChanged();
return;
case Z21Enums::DB0SetPowerOff:
logger->Debug(Languages::TextBoosterIsTurnedOff);
manager.Booster(ControlTypeZ21Server, BoosterStateStop);
return;
case Z21Enums::DB0SetPowerOn:
logger->Debug(Languages::TextBoosterIsTurnedOn);
manager.Booster(ControlTypeZ21Server, BoosterStateGo);
return;
default:
SendUnknownCommand();
return;
}
}
void Z21Client::ParseLocoDrive(const unsigned char* buffer)
{
const ObjectIdentifier locoBaseIdentifier(manager.GetIdentifierOfServerLocoAddress(ParseLocoAddress(buffer + 6)));
Speed speed;
switch(buffer[5])
{
case Z21Enums::DB0SetLocoDrive14:
speed = Hardware::Protocols::Z21::DecodeSpeed14(buffer[8] & 0x7F);
break;
case Z21Enums::DB0SetLocoDrive28:
speed = Hardware::Protocols::Z21::DecodeSpeed28(buffer[8] & 0x7F);
break;
case Z21Enums::DB0SetLocoDrive128:
speed = Hardware::Protocols::Z21::DecodeSpeed128(buffer[8] & 0x7F);
break;
case Z21Enums::DB0LocoFunction:
{
const DataModel::LocoFunctionNr nr = buffer[8] & 0x3F;
const DataModel::LocoFunctionState on = static_cast<DataModel::LocoFunctionState>((buffer[8] >> 6) & 0x01);
manager.LocoBaseFunctionState(ControlTypeZ21Server, locoBaseIdentifier, nr, on);
return;
}
default:
speed = 0;
break;
}
manager.LocoBaseSpeed(ControlTypeZ21Server, locoBaseIdentifier, speed);
manager.LocoBaseOrientation(ControlTypeZ21Server, locoBaseIdentifier, static_cast<Orientation>(buffer[8] >> 7));
}
void Z21Client::SendLocoInfo(const DataModel::LocoBase* const locoBase)
{
unsigned char sendBuffer[15] = { 0x0F, 0x00, 0x40, 0x00, 0xEF, 0x00, 0x00, 0x04 };
const Address address = locoBase->GetServerAddress();
if (address == AddressNone)
{
return;
}
Utils::Integer::ShortToDataBigEndian(address, sendBuffer + 5);
sendBuffer[8] = (locoBase->GetOrientation() << 7) | Hardware::Protocols::Z21::EncodeSpeed128(locoBase->GetSpeed());
sendBuffer[9] = ((locoBase->GetFunctionState(0) & 0x01) << 4)
| ((locoBase->GetFunctionState(4) & 0x01) << 3)
| ((locoBase->GetFunctionState(3) & 0x01) << 2)
| ((locoBase->GetFunctionState(2) & 0x01) << 1)
| (locoBase->GetFunctionState(1) & 0x01);
sendBuffer[10] = ((locoBase->GetFunctionState(12) & 0x01) << 7)
| ((locoBase->GetFunctionState(11) & 0x01) << 6)
| ((locoBase->GetFunctionState(10) & 0x01) << 5)
| ((locoBase->GetFunctionState(9) & 0x01) << 4)
| ((locoBase->GetFunctionState(8) & 0x01) << 3)
| ((locoBase->GetFunctionState(7) & 0x01) << 2)
| ((locoBase->GetFunctionState(6) & 0x01) << 1)
| (locoBase->GetFunctionState(5) & 0x01);
sendBuffer[11] = ((locoBase->GetFunctionState(20) & 0x01) << 7)
| ((locoBase->GetFunctionState(19) & 0x01) << 6)
| ((locoBase->GetFunctionState(18) & 0x01) << 5)
| ((locoBase->GetFunctionState(17) & 0x01) << 4)
| ((locoBase->GetFunctionState(16) & 0x01) << 3)
| ((locoBase->GetFunctionState(15) & 0x01) << 2)
| ((locoBase->GetFunctionState(14) & 0x01) << 1)
| (locoBase->GetFunctionState(12) & 0x01);
sendBuffer[12] = ((locoBase->GetFunctionState(28) & 0x01) << 7)
| ((locoBase->GetFunctionState(27) & 0x01) << 6)
| ((locoBase->GetFunctionState(26) & 0x01) << 5)
| ((locoBase->GetFunctionState(25) & 0x01) << 4)
| ((locoBase->GetFunctionState(24) & 0x01) << 3)
| ((locoBase->GetFunctionState(23) & 0x01) << 2)
| ((locoBase->GetFunctionState(22) & 0x01) << 1)
| (locoBase->GetFunctionState(21) & 0x01);
sendBuffer[13] = ((locoBase->GetFunctionState(31) & 0x01) << 2)
| ((locoBase->GetFunctionState(30) & 0x01) << 1)
| (locoBase->GetFunctionState(29) & 0x01);
sendBuffer[sizeof(sendBuffer) - 1] = Utils::Utils::CalcXORCheckSum(sendBuffer, sizeof(sendBuffer) - 1);
logger->Debug(Languages::Languages::TextSendingLocoInfo, address);
Send(sendBuffer, sizeof(sendBuffer));
}
void Z21Client::SendTurnoutInfo(const DataModel::AccessoryBase* const accessoryBase)
{
unsigned char sendBuffer[9] = { 0x09, 0x00, 0x40, 0x00, 0x43 };
const Address address = accessoryBase->GetServerAddress();
if (address == AddressNone)
{
return;
}
Utils::Integer::ShortToDataBigEndian(address - 1, sendBuffer + 5); // - 1 because Z21 address is 0-based
sendBuffer[7] = 1 << (accessoryBase->GetAccessoryState() & 0x01);
sendBuffer[sizeof(sendBuffer) - 1] = Utils::Utils::CalcXORCheckSum(sendBuffer, sizeof(sendBuffer) - 1);
logger->Debug(Languages::Languages::TextSendingTurnoutInfo, address);
Send(sendBuffer, sizeof(sendBuffer));
}
}} // namespace Server::Z21
|
