1 #include <msp/core/maputils.h>
2 #include <msp/io/print.h>
3 #include <msp/time/utils.h>
4 #include "arducontrol.h"
12 ArduControl::ProtocolInfo ArduControl::protocol_info[2] =
15 { 0x3FFF, 126, 15 } // MFX
18 ArduControl::ArduControl(const string &dev):
28 cmd.command[0] = READ_POWER_STATE;
30 command_queue.push(cmd);
32 cmd.command[0] = MFX_SET_STATION_ID;
38 command_queue.push(cmd);
41 ArduControl::~ArduControl()
46 void ArduControl::set_power(bool p)
50 PendingCommand cmd(POWER);
51 cmd.tag.serial = power.serial;
52 cmd.command[0] = (p ? POWER_ON : POWER_OFF);
54 command_queue.push(cmd);
58 void ArduControl::halt(bool)
62 const char *ArduControl::enumerate_protocols(unsigned i) const
72 ArduControl::Protocol ArduControl::map_protocol(const string &proto_name)
76 else if(proto_name=="MFX")
79 throw invalid_argument("ArduControl::map_protocol");
82 unsigned ArduControl::get_protocol_speed_steps(const string &proto_name) const
84 return protocol_info[map_protocol(proto_name)].max_speed;
87 const Driver::DetectedLocomotive *ArduControl::enumerate_detected_locos(unsigned i) const
89 if(i>=mfx_info.size())
95 unsigned ArduControl::add_loco(unsigned addr, const string &proto_name, const VehicleType &)
98 throw invalid_argument("ArduControl::add_loco");
100 Protocol proto = map_protocol(proto_name);
101 if(addr>protocol_info[proto].max_address)
102 throw invalid_argument("ArduControl::add_loco");
104 Locomotive loco(proto, addr);
105 insert_unique(locomotives, loco.id, loco);
110 void ArduControl::remove_loco(unsigned id)
112 Locomotive &loco = get_item(locomotives, id);
113 refresh.remove_loco(loco);
114 locomotives.erase(id);
117 void ArduControl::set_loco_speed(unsigned id, unsigned speed)
119 Locomotive &loco = get_item(locomotives, id);
120 if(speed>protocol_info[loco.proto].max_speed)
121 throw invalid_argument("ArduControl::set_loco_speed");
123 if(loco.speed.set(speed))
125 PendingCommand cmd(loco, Locomotive::SPEED);
126 command_queue.push(cmd);
128 refresh.add_loco(loco);
132 void ArduControl::set_loco_reverse(unsigned id, bool rev)
134 Locomotive &loco = get_item(locomotives, id);
135 if(loco.reverse.set(rev))
137 PendingCommand cmd(loco, Locomotive::REVERSE);
138 command_queue.push(cmd);
140 refresh.add_loco(loco);
144 void ArduControl::set_loco_function(unsigned id, unsigned func, bool state)
146 Locomotive &loco = get_item(locomotives, id);
147 if(func>protocol_info[loco.proto].max_func)
148 throw invalid_argument("ArduControl::set_loco_function");
150 unsigned mask = 1<<func;
151 if(loco.funcs.set((loco.funcs&~mask)|(mask*state)))
153 if(func>0 || loco.proto!=MM)
155 PendingCommand cmd(loco, Locomotive::FUNCTIONS, func);
156 command_queue.push(cmd);
159 refresh.add_loco(loco);
163 unsigned ArduControl::add_turnout(unsigned addr, const TrackType &type)
165 if(!addr || !type.is_turnout())
166 throw invalid_argument("ArduControl::add_turnout");
168 return add_accessory(Accessory::TURNOUT, addr, type.get_state_bits());
171 void ArduControl::remove_turnout(unsigned addr)
173 remove_accessory(Accessory::TURNOUT, addr);
176 void ArduControl::set_turnout(unsigned addr, unsigned state)
178 set_accessory(Accessory::TURNOUT, addr, state);
181 unsigned ArduControl::get_turnout(unsigned addr) const
183 return get_accessory(Accessory::TURNOUT, addr);
186 unsigned ArduControl::add_signal(unsigned addr, const SignalType &)
188 return add_accessory(Accessory::SIGNAL, addr, 1);
191 void ArduControl::remove_signal(unsigned addr)
193 remove_accessory(Accessory::SIGNAL, addr);
196 void ArduControl::set_signal(unsigned addr, unsigned state)
198 set_accessory(Accessory::SIGNAL, addr, state);
201 unsigned ArduControl::get_signal(unsigned addr) const
203 return get_accessory(Accessory::SIGNAL, addr);
206 unsigned ArduControl::add_accessory(Accessory::Kind kind, unsigned addr, unsigned bits)
208 AccessoryMap::iterator i = accessories.lower_bound(addr);
209 AccessoryMap::iterator j = accessories.upper_bound(addr+bits-1);
211 throw key_error(addr);
212 if(i!=accessories.begin())
215 if(i->first+i->second.bits>addr)
216 throw key_error(addr);
219 insert_unique(accessories, addr, Accessory(kind, addr, bits));
223 void ArduControl::remove_accessory(Accessory::Kind kind, unsigned addr)
225 Accessory &acc = get_item(accessories, addr);
227 throw key_error(addr);
228 accessories.erase(addr);
231 void ArduControl::set_accessory(Accessory::Kind kind, unsigned addr, unsigned state)
233 Accessory &acc = get_item(accessories, addr);
235 throw key_error(addr);
237 if(state!=acc.target)
240 accessory_queue.push_back(&acc);
244 unsigned ArduControl::get_accessory(Accessory::Kind kind, unsigned addr) const
246 const Accessory &acc = get_item(accessories, addr);
248 throw key_error(addr);
252 unsigned ArduControl::add_sensor(unsigned addr)
255 throw invalid_argument("ArduControl::add_sensor");
257 insert_unique(sensors, addr, Sensor(addr));
258 s88.grow_n_octets((addr+7)/8);
263 void ArduControl::remove_sensor(unsigned addr)
265 remove_existing(sensors, addr);
266 // TODO update s88.n_octets
269 bool ArduControl::get_sensor(unsigned addr) const
271 return get_item(sensors, addr).state;
274 void ArduControl::tick()
277 while(completed_commands.pop(tag))
279 if(tag.type==Tag::GENERAL)
281 if(tag.command==POWER)
283 if(power.commit(tag.serial))
284 signal_power.emit(power.current);
286 else if(tag.command==NEW_LOCO)
289 if(mfx_search.pop_info(info))
291 MfxInfoArray::iterator i;
292 for(i=mfx_info.begin(); (i!=mfx_info.end() && i->id!=info.id); ++i) ;
293 if(i==mfx_info.end())
295 mfx_info.push_back(info);
296 i = --mfx_info.end();
300 signal_locomotive_detected.emit(*i);
304 else if(tag.type==Tag::LOCOMOTIVE)
306 LocomotiveMap::iterator i = locomotives.find(tag.id);
307 if(i==locomotives.end())
310 Locomotive &loco = i->second;
311 if(tag.command==Locomotive::SPEED)
313 if(loco.speed.commit(tag.serial))
314 signal_loco_speed.emit(loco.id, loco.speed, loco.reverse);
316 else if(tag.command==Locomotive::REVERSE)
318 if(loco.reverse.commit(tag.serial))
319 signal_loco_speed.emit(loco.id, loco.speed, loco.reverse);
321 else if(tag.command==Locomotive::FUNCTIONS)
323 unsigned old = loco.funcs;
324 if(loco.funcs.commit(tag.serial))
326 unsigned changed = old^loco.funcs;
327 for(unsigned j=0; changed>>j; ++j)
329 signal_loco_function.emit(loco.id, j, (loco.funcs>>j)&1);
333 else if(tag.type==Tag::ACCESSORY)
335 AccessoryMap::iterator i = accessories.find(tag.id);
336 if(i==accessories.end())
339 Accessory &acc = i->second;
340 if(tag.command==Accessory::ACTIVATE)
342 off_timeout = Time::now()+acc.active_time;
344 else if(tag.command==Accessory::DEACTIVATE)
346 if(acc.state.commit(tag.serial))
348 if(acc.state==acc.target)
350 if(acc.kind==Accessory::TURNOUT)
351 signal_turnout.emit(acc.address, acc.state);
352 else if(acc.kind==Accessory::SIGNAL)
353 signal_signal.emit(acc.address, acc.state);
355 if(&acc==active_accessory)
356 active_accessory = 0;
360 else if(tag.type==Tag::SENSOR)
362 SensorMap::iterator i = sensors.find(tag.id);
366 Sensor &sensor = i->second;
367 if(tag.command==Sensor::STATE)
369 if(sensor.state.commit(tag.serial))
370 signal_sensor.emit(sensor.address, sensor.state);
375 while(!active_accessory && !accessory_queue.empty())
377 Accessory &acc = *accessory_queue.front();
379 if(acc.state!=acc.target)
381 active_accessory = &acc;
383 unsigned changes = acc.state^acc.target;
384 unsigned lowest_bit = changes&~(changes-1);
386 for(i=0; (lowest_bit>>i)>1; ++i) ;
387 acc.state.set(acc.state^lowest_bit);
388 PendingCommand cmd(acc, Accessory::ACTIVATE, i);
389 command_queue.push(cmd);
392 accessory_queue.pop_front();
395 if(active_accessory && off_timeout)
397 Time::TimeStamp t = Time::now();
400 off_timeout = Time::TimeStamp();
401 PendingCommand cmd(*active_accessory, Accessory::DEACTIVATE);
402 command_queue.push(cmd);
407 void ArduControl::flush()
412 ArduControl::Tag::Tag():
420 ArduControl::Locomotive::Locomotive(Protocol p, unsigned a):
430 unsigned ArduControl::Locomotive::create_speed_dir_command(char *buffer) const
434 buffer[0] = MOTOROLA_SPEED_DIRECTION;
436 buffer[2] = funcs.pending&1;
437 buffer[3] = speed.pending+reverse.pending*0x80;
442 buffer[0] = MFX_SPEED;
443 buffer[1] = address>>8;
445 buffer[3] = speed.pending+reverse.pending*0x80;
452 unsigned ArduControl::Locomotive::create_speed_func_command(unsigned f, char *buffer) const
457 throw invalid_argument("Locomotive::create_speed_func_command");
459 buffer[0] = MOTOROLA_SPEED_FUNCTION;
461 buffer[2] = (f<<4)|(((funcs.pending>>f)&1)<<1)|(funcs.pending&1);
462 buffer[3] = speed.pending;
467 bool f16 = (funcs.pending>0xFF);
468 buffer[0] = (f16 ? MFX_SPEED_FUNCS16 : MFX_SPEED_FUNCS8);
469 buffer[1] = address>>8;
471 buffer[3] = speed.pending+reverse.pending*0x80;
474 buffer[4] = funcs.pending>>8;
475 buffer[5] = funcs.pending;
480 buffer[4] = funcs.pending;
489 ArduControl::Accessory::Accessory(Kind k, unsigned a, unsigned b):
494 active_time(500*Time::msec)
497 unsigned ArduControl::Accessory::create_state_command(unsigned b, bool c, char *buffer) const
500 throw invalid_argument("Accessory::create_state_command");
502 unsigned a = (address+b+3)*2;
503 if(!((state.pending>>b)&1))
505 buffer[0] = MOTOROLA_SOLENOID;
507 buffer[2] = ((a&7)<<4)|c;
512 ArduControl::Sensor::Sensor(unsigned a):
518 ArduControl::PendingCommand::PendingCommand():
523 ArduControl::PendingCommand::PendingCommand(GeneralCommand cmd):
527 tag.type = Tag::GENERAL;
531 ArduControl::PendingCommand::PendingCommand(Locomotive &loco, Locomotive::Command cmd, unsigned index):
534 tag.type = Tag::LOCOMOTIVE;
537 if(cmd==Locomotive::SPEED)
539 tag.serial = loco.speed.serial;
540 length = loco.create_speed_dir_command(command);
542 else if(cmd==Locomotive::REVERSE)
544 tag.serial = loco.reverse.serial;
545 length = loco.create_speed_dir_command(command);
547 else if(cmd==Locomotive::FUNCTIONS)
549 tag.serial = loco.funcs.serial;
550 length = loco.create_speed_func_command(index, command);
553 throw invalid_argument("PendingCommand");
556 ArduControl::PendingCommand::PendingCommand(Accessory &acc, Accessory::Command cmd, unsigned index):
559 tag.type = Tag::ACCESSORY;
561 tag.id = acc.address;
562 if(cmd==Accessory::ACTIVATE || cmd==Accessory::DEACTIVATE)
564 tag.serial = acc.state.serial;
565 length = acc.create_state_command(index, (cmd==Accessory::ACTIVATE), command);
568 throw invalid_argument("PendingCommand");
573 void ArduControl::Queue<T>::push(const T &item)
575 MutexLock lock(mutex);
576 items.push_back(item);
580 bool ArduControl::Queue<T>::pop(T &item)
582 MutexLock lock(mutex);
586 item = items.front();
592 ArduControl::RefreshTask::RefreshTask():
599 bool ArduControl::RefreshTask::get_work(PendingCommand &cmd)
601 if(loco && loco->proto==MM && phase==0)
603 cmd.length = loco->create_speed_func_command(round%4+1, cmd.command);
604 cmd.repeat_count = 2;
609 loco = get_next_loco();
616 cmd.length = loco->create_speed_dir_command(cmd.command);
617 cmd.repeat_count = 2;
619 else if(loco->proto==MFX)
620 cmd.length = loco->create_speed_func_command(0, cmd.command);
627 void ArduControl::RefreshTask::add_loco(Locomotive &l)
629 MutexLock lock(mutex);
633 LocomotivePtrList::iterator oldest = cycle.begin();
634 for(LocomotivePtrList::iterator i=cycle.begin(); ++i!=cycle.end(); )
635 if((*i)->last_change_age>(*oldest)->last_change_age)
641 if(next==cycle.end())
642 next = cycle.begin();
645 void ArduControl::RefreshTask::remove_loco(Locomotive &l)
647 MutexLock lock(mutex);
648 for(LocomotivePtrList::iterator i=cycle.begin(); i!=cycle.end(); ++i)
663 ArduControl::Locomotive *ArduControl::RefreshTask::get_next_loco()
665 MutexLock lock(mutex);
669 Locomotive *l = *next;
674 void ArduControl::RefreshTask::advance()
677 if(next==cycle.end())
685 ArduControl::S88Task::S88Task(ArduControl &c):
691 bool ArduControl::S88Task::get_work(PendingCommand &cmd)
693 if(octets_remaining || !n_octets)
696 octets_remaining = n_octets;
697 cmd.command[0] = S88_READ;
698 cmd.command[1] = octets_remaining;
704 void ArduControl::S88Task::process_reply(const char *reply, unsigned length)
706 unsigned char type = reply[0];
707 if(type==S88_DATA && length>2)
709 unsigned offset = static_cast<unsigned char>(reply[1]);
710 unsigned count = length-2;
712 SensorMap::iterator begin = control.sensors.lower_bound(offset*8+1);
713 SensorMap::iterator end = control.sensors.upper_bound((offset+count)*8);
714 for(SensorMap::iterator i=begin; i!=end; ++i)
716 unsigned bit_index = i->first-1-offset*8;
717 bool state = (reply[2+bit_index/8]>>(7-bit_index%8))&1;
718 i->second.state.set(state);
721 tag.type = Tag::SENSOR;
722 tag.command = Sensor::STATE;
723 tag.serial = i->second.state.serial;
725 control.completed_commands.push(tag);
728 if(count>octets_remaining)
729 octets_remaining = 0;
731 octets_remaining -= count;
735 void ArduControl::S88Task::set_n_octets(unsigned n)
740 void ArduControl::S88Task::grow_n_octets(unsigned n)
747 ArduControl::MfxAnnounceTask::MfxAnnounceTask():
751 bool ArduControl::MfxAnnounceTask::get_work(PendingCommand &cmd)
753 Time::TimeStamp t = Time::now();
757 cmd.command[0] = MFX_ANNOUNCE;
758 cmd.command[1] = serial>>8;
759 cmd.command[2] = serial;
761 next = t+400*Time::msec;
766 void ArduControl::MfxAnnounceTask::set_serial(unsigned s)
772 ArduControl::MfxSearchTask::MfxSearchTask(ArduControl &c):
780 bool ArduControl::MfxSearchTask::get_work(PendingCommand &cmd)
785 IO::print("Assigning MFX address %d to decoder %08X\n", next_address, bits);
788 info.protocol = "MFX";
789 info.address = next_address;
790 info.name = format("%08X", bits);
794 cmd.command[0] = MFX_ASSIGN_ADDRESS;
795 cmd.command[1] = next_address>>8;
796 cmd.command[2] = next_address;
797 for(unsigned i=0; i<4; ++i)
798 cmd.command[3+i] = bits>>(24-i*8);
801 cmd.tag.type = Tag::GENERAL;
802 cmd.tag.command = NEW_LOCO;
812 Time::TimeStamp t = Time::now();
816 cmd.command[0] = MFX_SEARCH;
817 for(unsigned i=0; i<4; ++i)
818 cmd.command[1+i] = bits>>(24-i*8);
819 cmd.command[5] = size;
822 next = t+200*Time::msec;
825 IO::print("Search %08X/%d\n", bits, size);
830 void ArduControl::MfxSearchTask::process_reply(const char *reply, unsigned length)
832 unsigned char type = reply[0];
833 if(type==MFX_SEARCH_FEEDBACK && length==2)
840 else if(size>0 && misses<6)
843 bits ^= 1<<(32-size);
847 next = Time::now()+2*Time::sec;
855 bool ArduControl::MfxSearchTask::pop_info(MfxInfo &info)
857 return queue.pop(info);
861 ArduControl::ControlThread::ControlThread(ArduControl &c):
865 tasks.push_back(&control.mfx_announce);
866 tasks.push_back(&control.mfx_search);
867 tasks.push_back(&control.s88);
868 tasks.push_back(&control.refresh);
873 void ArduControl::ControlThread::exit()
879 void ArduControl::ControlThread::main()
889 for(unsigned i=0; (success && i<cmd.repeat_count); ++i)
890 success = (do_command(cmd)==COMMAND_OK);
891 if(success && cmd.tag)
892 control.completed_commands.push(cmd.tag);
895 Time::sleep(10*Time::msec);
899 void ArduControl::ControlThread::init_baud_rate()
901 static unsigned rates[] = { 57600, 9600, 19200, 38400, 0 };
903 control.serial.set_data_bits(8);
904 control.serial.set_parity(IO::Serial::NONE);
905 control.serial.set_stop_bits(1);
906 for(unsigned i=0; rates[i]; ++i)
908 control.serial.set_baud_rate(rates[i]);
909 control.serial.put('\xFF');
910 if(IO::poll(control.serial, IO::P_INPUT, 500*Time::msec))
912 int c = control.serial.get();
928 IO::print("ArduControl detected at %d bits/s\n", rate);
933 cmd.command[0] = SET_BAUD_RATE;
934 cmd.command[1] = rates[0]>>8;
935 cmd.command[2] = rates[0];
937 if(do_command(cmd)==COMMAND_OK)
939 control.serial.set_baud_rate(rates[0]);
940 Time::sleep(Time::sec);
941 if(do_command(cmd)==COMMAND_OK)
944 IO::print("Rate changed to %d bits/s\n", rates[0]);
950 bool ArduControl::ControlThread::get_work(PendingCommand &cmd)
952 if(control.command_queue.pop(cmd))
955 for(vector<Task *>::iterator i=tasks.begin(); i!=tasks.end(); ++i)
956 if((*i)->get_work(cmd))
959 // As fallback, send an idle packet for the MM protocol
960 cmd.command[0] = MOTOROLA_SPEED;
969 unsigned ArduControl::ControlThread::do_command(const PendingCommand &cmd)
974 for(unsigned i=0; i<cmd.length; ++i)
975 cmd_hex += format(" %02X", static_cast<unsigned char>(cmd.command[i]));
976 IO::print("< %02X%s\n", cmd.length^0xFF, cmd_hex);
979 control.serial.put(cmd.length^0xFF);
980 control.serial.write(cmd.command, cmd.length);
987 got_data = IO::poll(control.serial, IO::P_INPUT, Time::zero);
989 got_data = IO::poll(control.serial, IO::P_INPUT);
994 unsigned rlength = control.serial.get()^0xFF;
997 IO::print("Invalid length %02X\n", rlength);
1004 pos += control.serial.read(reply+pos, rlength-pos);
1006 if(control.debug>=2)
1009 for(unsigned i=0; i<rlength; ++i)
1010 reply_hex += format(" %02X", static_cast<unsigned char>(reply[i]));
1011 IO::print("> %02X%s\n", rlength^0xFF, reply_hex);
1014 unsigned r = process_reply(reply, rlength);
1022 unsigned ArduControl::ControlThread::process_reply(const char *reply, unsigned rlength)
1024 unsigned char type = reply[0];
1025 if((type&0xE0)==0x80)
1027 if(type!=COMMAND_OK)
1028 IO::print("Error %02X\n", type);
1031 else if(type==POWER_STATE && rlength==2)
1033 control.power.set(reply[1]);
1036 tag.type = Tag::GENERAL;
1037 tag.command = POWER;
1038 tag.serial = control.power.serial;
1039 control.completed_commands.push(tag);
1043 for(vector<Task *>::iterator i=tasks.begin(); i!=tasks.end(); ++i)
1044 (*i)->process_reply(reply, rlength);