Speckle 2
.
The Speckle 2
package contains the main nodes necessary to use Speckle within Dynamo, including nodes for sending and receiving data, managing streams and selecting accounts.
We’ve also built a few nodes for more advanced use cases, as well as some handy tools for Speckle developers/hackers (these are found in the Developer Tools
sub-section of the package).
https://app.speckle.systems/streams/3073b96e86
points to the main
branch on Stream 3073b96e86
https://app.speckle.systems/streams/3073b96e86/branches/dev
points to a branch named dev
on Stream 3073b96e86
https://app.speckle.systems/streams/3073b96e86/commits/604bea8cc6
points to a specific commit 604bea8cc6
on Stream 3073b96e86
https://app.speckle.systems/streams/3073b96e86/objects/df7b8bafccefa791d82939dd36541189
points to a specific object df7b8bafccefa791d82939dd36541189
on Stream 3073b96e86
Send Data
node.
streamUrl
port.
data
input in the Send Data
node. The node will automatically convert any supported Dynamo objects into a Speckle-compatible format.
message
port.
The commit message will be visible in the Speckle Web App (where you will also be able to edit it).
main
branch is used to send and receive data.
To send to a specific branch, simply use the branch URL, such as: https://app.speckle.systems/streams/3073b96e86/branches/dev
.
Receive Data
node, and a stream URL.
main
branch is used to send and receive data by default.
You can also receive data from a specific branch; simply use the branch URL, such as: https://app.speckle.systems/streams/3073b96e86/branches/dev
.
https://app.speckle.systems/streams/3073b96e86/commits/604bea8cc6
https://app.speckle.systems/streams/3073b96e86/objects/df7b8bafccefa791d82939dd36541189
.
Like commits, objects in a commit cannot be edited, so the data received using such a URL will always be consistent. You can find the ID of an object from the Speckle Web interface:
Custom Object
is a Base Object with custom properties assigned to it. It’s basically a custom data structure you can create to send data in a specific format that you define.
In Dynamo, we use dictionaries to represent custom objects since they are natively supported, so creating custom objects is as simple as creating a dictionary containing the keys and values you wish to include in the Base
object.
This dictionary will be automatically converted to a Base
object during the Send operation.
Base
objects, it will also perform the conversion to Speckle automatically.Stream
component category, but also stream urls in text format."Dynamo push"
.Stream
or any other valid Transport
. Whenever possible, the receiver node will try to convert all Speckle objects into compatible objects.
Base
objects, it will also perform the conversion to Speckle automatically.id
for the data that was locally sent.id
for the data you want to fetch locally. This would be provided from a Send Local Data node.Base
objects, it will also perform the conversion to Speckle automatically.Accounts must be set-up in your computer using the Speckle Manager.
Create Stream
node. This node has a custom UI that allows you to select a specific account to use, and a button to confirm the stream creation.
Once created, the node will remember that stream. Meaning you will not be able to change the stream you created, or create a new one using the same node (to do this, just place a new Create Stream
node).
Select the appropriate account and press the blue button. If the stream creation was successful, the output of the node should be a stream url pointing to the newly created stream and linked to the specified account.
This node has no inputs.
Stream
, given its URL and a specific account to access that stream with. This may be useful if there are multiple accounts registered on the same machine and a certain stream requires a specific account to be accessible.
Stream
object pointing to existing stream. If the stream doesn’t exist, an error will be shown.Stream
objects available to the specified account.Stream
.
Stream
component category, but also stream urls in text format.id
that identifies the stream.JSON
formatted text.
JSON
format into Base
Speckle objects.