Skip to content

Commit ead5e59

Browse files
committed
Fix EX-FastClock typos
1 parent 3460ab3 commit ead5e59

5 files changed

Lines changed: 16 additions & 17 deletions

File tree

docs/products/ex-fastclock/01-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Each time the time changes the EX-CommandStation looks for a time change event a
2626

2727
EX-FastClock allows the FastClock device to connect to the EX-CommandStation via either Serial Communications or I2C. Even though EX-FastClock provides the code for an Uno based Clock it should be possible for tinkerer level users to add the relevant code if they already have a working clock that they wish to integrate to EX-CommandStation.
2828

29-
To make full use of EX-FastClock**, you will need a basic understanding of EX-RAIL automation, but we'll share the details and some examples to help with this.
29+
To make full use of EX-FastClock, you will need a basic understanding of EX-RAIL automation, but we'll share the details and some examples to help with this.
3030

3131
**NOTE**: EX-FastClock is in public Beta testing, and as such, we encourage regular feedback on the success or otherwise of both the software and documentation. Please reach out via any of our support methods and help us get EX-FastClock as easy to use and reliable as possible.
3232

@@ -41,7 +41,7 @@ The EX-FastClock integration includes:
4141

4242
## Credit where credit is due
4343

44-
*The EX-FastClock is based on a project originally written by Jim Gifford (Hallet Cove Southern) in June 2017. That project used a 32 x 8 LED matrix to display the time and was controlled by a number of pushbuttons. You can see [Jim's Original Project here](https://www.hallettcovesouthern.com/track-plan-design-info/arduino-projects/fast-clock/).
44+
The EX-FastClock is based on a project originally written by Jim Gifford (Hallet Cove Southern) in June 2017. That project used a 32 x 8 LED matrix to display the time and was controlled by a number of pushbuttons. You can see [Jim's Original Project here](https://www.hallettcovesouthern.com/track-plan-design-info/arduino-projects/fast-clock/).
4545

4646
- MCUFRIEND.kbv credit: This library was written by David Prentice and has become the De-Facto standard for the shield based TFT screens used in this project. This library inherits from the Adafruit GFX library.
4747
- Adafruit for the Adafruit GFX Library.

docs/products/ex-fastclock/05-installation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
The EX-FastClock Software will be found in the appropriate repository in the DCC-EX repository on Github
44

5-
This repositry currently contains two branches:
5+
This repository currently contains two branches:
66

7-
1. Main. This branch contains a copy of the code and ancilliary files on PlatformIO configuration.
7+
1. Main. This branch contains a copy of the code and ancillary files on PlatformIO configuration.
88
2. Arduino IDE. This branch contains the files in the necessary structure for use with the Ardiuino IDE
99

1010
## Libraries
1111

12-
The project requires three libraries -
12+
The project requires three libraries:
1313

1414
- Adafruit_GFX
1515
- Adafruit_Touchscreen
16-
- MCUFRIEND_kbv.
16+
- MCUFRIEND_kbv
1717

18-
All three can be installed from the Arduino IDE library manager or Platformio Library system as required however for compatability where possible use the copies supplied in the repositiory folder.
18+
All three can be installed from the Arduino IDE library manager or Platformio Library system as required however for compatibility where possible use the copies supplied in the repository folder.
1919

2020
### Platformio
2121

@@ -27,4 +27,4 @@ Select the Arduino IDE branch from the repository and click on the CODE button.
2727

2828
### Both Environments
2929

30-
I have generated two special fonts for the project which can be found in the Fonts folder in the Adafruit GFX Library in this repository. These should be copied into the fonts folder in the Adafruit_GFX library once installed. The file Arial9pt7b.h congtains a fullset of the Arial Font as used in Windows. The file Arial48pt7b.h contains a large 48pt Arial font containing only charachters 0-9 and :. This is used to display the time clock on the screen. The full font was too large to fit into the Uno memory.
30+
I have generated two special fonts for the project which can be found in the Fonts folder in the Adafruit GFX Library in this repository. These should be copied into the fonts folder in the Adafruit_GFX library once installed. The file Arial9pt7b.h contains a full set of the Arial Font as used in Windows. The file Arial48pt7b.h contains a large 48pt Arial font containing only characters 0-9 and :. This is used to display the time clock on the screen. The full font was too large to fit into the Uno memory.

docs/products/ex-fastclock/06-configuration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The config.h file comes pre-configured to use the clock in standalone mode. No
1414

1515
## Serial Mode
1616

17-
To communicatein Serial mode it is necessary to edit the config.h file and uncomment the following line:
17+
To communicate in Serial mode it is necessary to edit the config.h file and uncomment the following line:
1818

1919
```cpp
2020
//#define SEND_VIA_SERIAL true
@@ -31,11 +31,11 @@ To operate in I2C mode edit the config.h file and uncomment the following lines:
3131
//#define SEND_VIA_I2C true
3232
```
3333

34-
In this mode the CS will poll the FastClock to obtain the time. It is necessary to set the same I2C address here as used in the myHal.cpp file within the CS. This is set to a default of 0x55 (decimal 85) but can be set to some other value if this conflicts with othere I2C devices on your setup.
34+
In this mode the CS will poll the FastClock to obtain the time. It is necessary to set the same I2C address here as used in the myHal.cpp file within the CS. This is set to a default of 0x55 (decimal 85) but can be set to some other value if this conflicts with other I2C devices on your setup.
3535

3636
## Screen Header
3737

38-
By default the top of the clock screen displays the name of my own layout. To inset your layout name then change the following line.
38+
By default the top of the clock screen displays the name of my own layout. To insert your layout name change the following line.
3939

4040
```cpp
4141
char header[HDDR_SIZE] = {"Nantyderry Junction"};
@@ -52,7 +52,7 @@ const int TS_LEFT=899,TS_RT=122,TS_TOP=100,TS_BOT=898;
5252

5353
## Configure existing clock
5454

55-
If you already have a FastCLock there are a number of couple of configuration options which allow you to connect your own clock to a Command Station.
55+
If you already have a FastClock there are a number of couple of configuration options which allow you to connect your own clock to a Command Station.
5656

5757
The various configuration options are outlined below
5858

@@ -63,7 +63,7 @@ The various configuration options are outlined below
6363
Connecting via Serial is the simplest option if available.
6464

6565
- Run a dupont cable from the TX pin on the arduino to a RX pin on the EX-CommandStation. It is not usually necessary to run a cable from RX to the TX on the EX-CommandStation as the FastClock is not receiving data back.
66-
- Find the Serial defines in the config.h file (or copy config.example.h to config.h if you dont have one), locate the following lines:
66+
- Find the Serial defines in the config.h file (or copy config.example.h to config.h if you don't have one), locate the following lines:
6767

6868
```cpp
6969
//#define SERIAL1_COMMANDS
@@ -158,4 +158,4 @@ void TransmitTime() {
158158

159159
- The CommandStation-EX will now poll the FastClock to request the time. The frequency at which it does so is influenced by the clock speed (i.e. on a slow clock speed it polls less often).
160160

161-
Now that you know how to connect your existing FastCLock, click the "next" button see how you use EX-FastClock.
161+
Now that you know how to connect your existing FastClock, click the "next" button see how you use EX-FastClock.

docs/products/ex-fastclock/10-operation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
At startup the clock will calculate a start time based on either a) a coded start time (currently 6:00 a.m.) or b) a run time stored in the EEPROM (see item 2) below.
44

5-
The clock will start in a paused state and will display the speed rate factor (default = x 4). Once any adjustemts have been made the clock can be started. The usage of the six buttons are as below:
5+
The clock will start in a paused state and will display the speed rate factor (default = x 4). Once any adjustments have been made the clock can be started. The usage of the six buttons are as below:
66

77
1. **Start** - Pressing this button will start the clock and the button text will change to **Pause**.
8-
2. **Save** - Pressing this button will pause the clock and save the current time and Speed Factor to the EEPROM. These figures will be used to initialise the clock on nextstartup.
8+
2. **Save** - Pressing this button will pause the clock and save the current time and Speed Factor to the EEPROM. These figures will be used to initialise the clock on next startup.
99
3. **Reset** - Pressing this button will pause the clock and set the time to 06:00 with a speed factor of 4.
1010
4. **T+** - Pressing this key will pause the clock and add 15 minutes to the time.
1111
5. **T-** - Pressing this key will pause the clock and deduct 15 minutes from the time.

docs/products/ex-fastclock/15-timecontrol.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Time Control
32

43
## EXRAIL Commands

0 commit comments

Comments
 (0)