Model Railroad System  2.2.2
Model RR signals with an Arduino
Introduction.h
1 // -!- c++ -!- //////////////////////////////////////////////////////////////
2 //
3 // System :
4 // Module :
5 // Object Name : $RCSfile$
6 // Revision : $Revision$
7 // Date : $Date$
8 // Author : $Author$
9 // Created By : Robert Heller
10 // Created : Sun Jul 26 16:31:52 2015
11 // Last Modified : <150727.1750>
12 //
13 // Description
14 //
15 // Notes
16 //
17 // History
18 //
19 /////////////////////////////////////////////////////////////////////////////
20 //
21 // Copyright (C) 2015 Robert Heller D/B/A Deepwoods Software
22 // 51 Locke Hill Road
23 // Wendell, MA 01379-9728
24 //
25 // This program is free software; you can redistribute it and/or modify
26 // it under the terms of the GNU General Public License as published by
27 // the Free Software Foundation; either version 2 of the License, or
28 // (at your option) any later version.
29 //
30 // This program is distributed in the hope that it will be useful,
31 // but WITHOUT ANY WARRANTY; without even the implied warranty of
32 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 // GNU General Public License for more details.
34 //
35 // You should have received a copy of the GNU General Public License
36 // along with this program; if not, write to the Free Software
37 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
38 //
39 //
40 //
41 //////////////////////////////////////////////////////////////////////////////
42 
43 #ifndef __INTRODUCTION_H
44 #define __INTRODUCTION_H
45 
46 /** @page Introduction Introduction
47  * I will be building an interlocking plant module with 5 two-headed signals.
48  * To drive all of these signals I will be using an Arduino and a Max72XX Led
49  * driver (see http://playground.arduino.cc/Main/MAX72XXHardware
50  * for more information about general uses for the Arduino and the Max72XX
51  * chips). This article describes the hardware involved, the firmware
52  * (software on the Arduino) and the host computer software (using the
53  * Dispatcher program from my Model Railroad System).
54  *
55  * @section layoutmodule The layout module
56  *
57  * @image latex Xover-WithSiding.png "Crossover with siding" width=5in
58  * @image html Xover-WithSiding-small.png
59  * The layout module is a simple double track main line with a single
60  * crossover and an industrial siding, as shown here. There will be a
61  * two-track signal bridge (Oregon Rail Supply #151) at the east (right) end
62  * of the interlocking plant and a three-track signal bridge (Oregon Rail
63  * Supply #154, cut down to three tracks) at the west (left) end of the
64  * interlocking plant. At the east end will be a 3 over 2 on track 1
65  * (upper/north main line) and a 3 over 3 on track 2 (lower/south main line).
66  * At the west end will be a 1 over 3 on the siding exit, a 3 over 3 on track
67  * 1 (upper/north main line) and a 3 over 1 on track 2 (lower/south main
68  * line).
69  *
70  * @section HardwareUsed Hardware being used
71  *
72  * I will be using <a href="http://www.oregonrail.com/new.html" target="_blank">Oregon Rail Supply</a>
73  * signal bridges, one 2-track (#151) and one 4-track (#154, cut down to
74  * 3-tracks). I will be using 2mm x 1.25mm chip LEDs (
75  * <a href="http://www.mouser.com" target="_blank">Mouser</a> part numbers
76  * <a href="https://www.mouser.com/Search/ProductDetail.aspx?R=LG_R971-KN-1virtualkey62510000virtualkey720-LGR971-KN-1" target="_blank">720-LGR971-KN-1</a>,
77  * <a href="https://www.mouser.com/Search/ProductDetail.aspx?R=LY_R976-PS-36virtualkey62510000virtualkey720-LYR976-PS-36" target="_blank">720-LYR976-PS-36</a>,
78  * and <a href="https://www.mouser.com/Search/ProductDetail.aspx?R=LS_R976-NR-1virtualkey62510000virtualkey720-LSR976-NR-1" target="_blank">720-LSR976-NR-1</a>)
79  * on small circuit boards to light these signals. There will be an Arduino
80  * Uno (<a href="http://www.mouser.com" target="_blank">Mouser</a> part number
81  * <a href="https://www.mouser.com/Search/ProductDetail.aspx?R=A000066virtualkey24200000virtualkey782-A000066" target="_blank">782-A000066</a>)
82  * and a home built board (based on the Arduino Playground circuit) containing
83  * a Max7221 (Mouser Parts: <a href="https://www.mouser.com/ProjectManager/ProjectDetail.aspx?AccessID=982ba0c79b" target="_blank">Mouser Project</a>
84  * ). This manual describes how I built these signals and
85  * how I will control them from my Linux computer, using a CTC panel created
86  * with my Model Railroad System Dispatcher program.
87  * @htmlonly
88  * A ZIP archive containing the PCB Layout/assembly files is available here:
89  * <a href="SignalDriverMax72xx.zip">SignalDriverMax72xx.zip</a>.
90  * @endhtmlonly
91  * @latexonly
92  * A ZIP archive containing the PCB Layout/assembly files is available in the
93  * file SignalDriverMax72xx.zip in the same folder as this PDF file.
94  * @endlatexonly
95  * @htmlonly
96  * <div class="contents"><a class="el" href="SignalDriverBoard.html">Continuing with the Signal Driver board</a></div>
97  * @endhtmlonly
98  */
99 
100 #endif // __INTRODUCTION_H
101