Module for designer sync with gateway

Module Development
1

I’m looking to build a module that allows for the following behavior:

  1. less ideal option: a button in the designer that when clicked runs the ‘update project, accept gateway changes’ flow.

  2. more ideal: a file watcher that triggers that same flow upon the creation of a specific file, and then deletes the file

  3. most ideal: web API that runs that (if it could somehow live on the gateway that’d be awesome but I imagine that would require a nightmare of message handler complexity).

Where in the SDK would I look for hooks into that designer update flow?

2

Hi Leor,

Is this for 8.3 or 8.1?

8.3 exposes an endpoint to trigger a projects scan and a config scan. This can be found by running an 8.3 gateway and navigating to http://localhost:8088/openapi. From there you can follow the API Keys guide.

For 8.1, I use Ignition Flint pretty extensively. This supports editing in VS Code and triggers a project scan when you save if the Ignition Project Scan module is enabled. Further, the module exposes an HTTP endpoint that allows you to call the scan if you want to roll your own implementation.

Doesn't exactly answer your question but I hope this helps.

1 Like
3

Oh, I know about how to get the gateway to update – my q is how to update the designer

4

There's no supported hook for a module to invoke the pull action in the designer.

Adding a route to the gateway is trivial in a custom module:

Though, you've had such a good idea that it already exists:

5

Project scan I know exists – the q is a gateway route for triggering designer pulls

6

Did you look at the README?

image
image1772×456 53.8 KB

3 Likes