Skip to content

Commit

Permalink
Merge pull request #39 from johnrm174/develop
Browse files Browse the repository at this point in the history
Develop
  • Loading branch information
johnrm174 authored Apr 22, 2023
2 parents ecace64 + 39266fb commit 5375efe
Show file tree
Hide file tree
Showing 35 changed files with 2,365 additions and 1,128 deletions.
5 changes: 4 additions & 1 deletion PUBLIC_API.md
Original file line number Diff line number Diff line change
Expand Up @@ -432,16 +432,19 @@ block_callback_type (tells the calling program what has triggered the callback)
block_section_ahead_updated - The block section AHEAD of our block section has been updated
(i.e. the block section state represented by the Repeater indicator)

instrument_type - enumeration type - single_line or double_line

create_block_instrument - Creates a Block Section Instrument on the schematic
Mandatory Parameters:
Canvas - The Tkinter Drawing canvas on which the instrument is to be displayed
block_id:int - The local identifier to be used for the Block Instrument
x:int, y:int - Position of the instrument on the canvas (in pixels)
Optional Parameters:
inst_type:instrument_type - either instrument_type.single_line or instrument_type.double_line
block_callback - The function to call when the repeater indicator on our instrument has been
updated (i.e. the block changed on the linked instrument) - default: null
Note that the callback function returns (item_id, callback type)
single_line:bool - for a single line instrument(created without a repeater) - default: False
single_line:bool - DEPRECATED - use inst_type instead
bell_sound_file:str - The filename of the soundfile (in the local package resources
folder) to use for the bell sound (default "bell-ring-01.wav" - other
options are "bell-ring-02.wav", "bell-ring-03.wav", "bell-ring-04.wav")
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,17 @@ From Release 3.0.0, the schematic editor application enables automated and inter
schemes to be designed and configured without the need to write any code. Note that the editor is in
active development so any comments and suggestions for future features are welcome.

What's supported in Release 3.2.0:
What's supported in Release 3.3.0:
* Draw your layout schematic with lines, points, signals and track occupancy sections
* Define the DCC command sequences to drive the signals and points out on the layout
* Configure the signals and points to implement protototypical interlocking schemes
* Configure GPIO sensors and track sections to provide a 'mimic' display of the layout
* Automation of signals as trains traverse the routes that have been configured
* Save and load your layout schematic and state between running sessions
* Block instruments - with interlocking of starting signals
* Popup error messages when things go wrong (reduced reliance on logs)

What's coming soon:
* Support for block section instruments
* MQTT networking (for linking layouts)
* Application documentation

Expand Down
Loading

0 comments on commit 5375efe

Please sign in to comment.