Open
Conversation
liamcmitchell
suggested changes
Apr 21, 2026
| * **AppKeyPair** - A persistent entity to store the app's key pair. The public key needs to be entered in the corresponding app in the Workstation Management. | ||
|
|
||
| ### Using the Nanoflows and Actions | ||
| ### Using the Nanoflows and Actions {#java-actions} |
Contributor
There was a problem hiding this comment.
Actions are JavaScript Actions, not Java
| Call `Unsubscribe` to end a subscription. | ||
|
|
||
| #### UnsubscribeByContext | ||
| #### SetupDevice |
Contributor
There was a problem hiding this comment.
After discussion today, we renamed this to GetCreateDevice. Same behavior, hopefully easier to understand.
|
|
||
| Call this action to unsubscribe and completely disconnect from a specific device. | ||
|
|
||
| #### Initialize |
Contributor
There was a problem hiding this comment.
Initialize needs to be called by something in order to set up communication with the Workstation Client.
Users shouldn't ever need to call this directly. It should be automatically called from within GetStation or GetCreateDevice. Users will need to pass it to GetCreateDevice as initialize for it to be called. This should be well documented in the action parameter description.
|
|
||
| #### GetStation | ||
|
|
||
| Call `GetStation` to retrieve configuration of the current Client computer by using the Workstation Client. `GetStation` can be used multiple times, but it queries the Workstation Client only the first time. The following calls return the current object loaded in the session. If connection with Workstation Client does not work, `GetStation` returns an empty object. |
Contributor
There was a problem hiding this comment.
Call `GetStation` to retrieve the current Workstation Client configuration and devices. Creates and returns a station object with a linked device object per peripheral.
|
|
||
| Call `GetStation` to retrieve configuration of the current Client computer by using the Workstation Client. `GetStation` can be used multiple times, but it queries the Workstation Client only the first time. The following calls return the current object loaded in the session. If connection with Workstation Client does not work, `GetStation` returns an empty object. | ||
|
|
||
| If your microflow references a peripheral module (that is, a reusable module which supports a specific peripheral device), you do not need to call `GetStation` to reference it. Instead, you can initialize the peripheral module by calling `Initialize`. |
Contributor
There was a problem hiding this comment.
If you need to interact with a specific device, prefer getting it via `GetCreateDevice` instead. It has a more convenient API, allows specialization and avoids creation of station and device objects that may not be needed.
Comment on lines
+151
to
+152
|
|
||
| Call this action to unsubscribe and completely disconnect from a specific device. |
Contributor
There was a problem hiding this comment.
Call this action to disconnect from a specific device.
Does not unsubscribe anything.
| @@ -86,46 +75,104 @@ The domain model contains the following entities: | |||
| * **Device** - A list of devices associated with the station; includes device names and properties required to achieve a connection (non-persistent entities). | |||
Contributor
There was a problem hiding this comment.
* **Station** - A non-persistent entity representing the Workstation Client configuration.
* **Device** - A non-persistent entity representing a connectable peripheral device. Includes name, class and available/connected/error states. Specialize this to maintain your device specific state.
| * `timeout` | ||
|
|
||
| The callback nanoflow must have the following parameters: | ||
| #### SubscribeToObjectChanges |
Contributor
There was a problem hiding this comment.
SubscribeToXxx might be better to come near the end. I see these as low-level APIs. Most users shouldn't need these. GetCreateDevice should be enough.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.