Skip to content

Add File watcher support#34

Open
panaaj wants to merge 20 commits intoSignalK:masterfrom
panaaj:chart-server
Open

Add File watcher support#34
panaaj wants to merge 20 commits intoSignalK:masterfrom
panaaj:chart-server

Conversation

@panaaj
Copy link
Member

@panaaj panaaj commented Sep 27, 2024

This PR adds a file watcher to charts folders to detect new files placed in the folder. This makes the new charts available to subsequent requests without having to restart the plugin (#28).

Removing the use of a shared path aligns better with multi-provider support.
Tile paths have a fully qualified path, remove use of relative path.
@panaaj panaaj added enhancement New feature or request feature labels Sep 27, 2024
@panaaj panaaj changed the title Mapbox Style support WIP: Mapbox Style support Sep 27, 2024
@panaaj panaaj requested review from sbender9 and tkurki October 2, 2024 06:46
@panaaj panaaj changed the title WIP: Mapbox Style support Add Mapbox Style support Oct 2, 2024
@panaaj panaaj changed the title Add Mapbox Style support Add File watcher and Mapbox Style support Nov 30, 2024
@panaaj
Copy link
Member Author

panaaj commented Nov 30, 2024

@tkurki Can you please review and if all is OK it's good to publish.

This code seemed to solve Freeboard-SK issue SignalK/freeboard-sk#211

README.md Outdated

Supports both v1 and v2 Signal K resources api paths.
Chart metadata is derived from the following supported chart files:
- Mapbox Tiles _(.mbtiles)_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Afaik MBTiles is better known as just MBTiles and touted as open format. The spec README never mentions Mapbox, while it is under their Github org.

We could link to the canonical resources?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to MBTiles.
Which canonical resources are you refferring to?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The repo I linked.

@tkurki
Copy link
Member

tkurki commented Jan 5, 2025

Unrelated to this PR: README is not very consistent

  • default location repeated
  • the steps-oriented configuration instructions are not very universal: some people will use online charts, others mbtiles etc

@msallin
Copy link

msallin commented May 4, 2025

I arrived here because I would like to have two things: 1. the file watcher, and 2. support for recursive folders.
I've a share with a folder called "charts," which contains subfolders with regions. Those subfolders contain multiple different charts for each region.

For a new region, I have to create the folder on the share, add it to the plugin, and restart for every chart I add.

This PR implements the watcher. WDYT about letting the user specify recursive paths?

@panaaj panaaj changed the title Add File watcher and Mapbox Style support Add File watcher support Jul 5, 2025
@tkurki
Copy link
Member

tkurki commented Jan 22, 2026

This would need rebasing and a bit of work to address my comment about the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants