Emulator code refactored - Githubissues

DCC-EX / WebThrottle-EX

WebThrottle-EX is a web based (html,jQuery,JavaScript) Controller/Throttle for DCC-EX EX-CommandStations

https://dcc-ex.com/WebThrottle-EX

GNU General Public License v3.0

21 stars 13 forks source link

Emulator code refactored #69

Closed dcyoung-dev closed 2 years ago

dcyoung-dev commented 2 years ago

What?

I have added/removed/altered:

[x] Refactored function emulator() into a class Emulator
[x] Refactored writeToStream
[x] Added a TurnoutsEmulator class
[x] Added a Turnout class

Why?

I am doing this because:

The main goal was to make the Emulator easier to read.
Emulator class now behaves in a similar manner to the outputstream making switching between Emulator and Serial outputs more seamless.
A clear separation of responsibilities has been created between Emulator and Turnout Emulator
These changes help pave the way towards testable, modularised code.

Acceptance Criteria

I can call this done when:

[x] Emulator behaves as it did previously

Deployment risks

Some assumptions have been made about the packet variable.
- For Turnouts, the subaddress previously included the > character. This has been removed in this PR.
All new code has been written using ES6 syntax. This is widely supported by modern browsers.