Using the plugin
The Grasshopper client is bundled as part of the Speckle installation package. Once installed, the components will appear under the Speckle tab of Grasshopper.
Within the Grasshopper tab, there are a number of components there to help you control how you use Speckle. The two key main compoments are:
- Data Sender
- Data Receiver
In most cases, you will work mainly with these components.
Sending a stream
To send data from the Grashopper client, place a Data Sender component onto the canvas. Once you do so, a login window will appear. From here, you can login to an account or register for a new one on the Speckle server of your choice. For testing purposes, you can use the Hestia server by entering
https://hestia.speckle.works/api for the Server Url. Do be advised that this is a test server - use at your own risk.
Once logged in, you will see the Speckle data sender on the canvas initialised. To send data, attach any data you wish to send to the component. For example, let us send attach a panel component with some text to the component. The text is now sent as part of the stream, ready for further use.
There are many features of the sender component which is useful for manipulating and organizing your data. The inputs of the sender are the layers of the stream; you can attach any data to an input and it will be sent within that layer of the stream. By zooming in, you can add or remove layers using the + and - buttons. Layers can be renamed by right-clicking the input and renaming the input itself.
Right-clicking on the component will bring up its context menu. From there, you can modify the name of the stream, control whether the stream should automatically update, or perform a force refresh.
Receiving a stream
The process for receiving a stream is similar to the process of sending a stream. First, place a Data Receiver component onto the canvas. A login window will appear which will allow you to login or register as before.
Once you login and the receiver component is initialized, you can receive a stream by entering a stream's
streamID as the ID input. Right-clicking on the component will bring up its context menu. From there, you can control whether the stream should automatically update or perform a force refresh.
Beyond the basics
We encourage you to play around with these components to get a feel for what is possible with Speckle. Outside of Grasshopper, you can use the stream you sent to:
- view it online
- receive in other clients
- get it as raw data via the API
- and more!
In addition to these two base components featured in this doc, the Grasshopper client has many other features and components which will allow you to have finer control over your data. If you wish to learn more about these features, please view the other Grasshopper documentation pages.
If you have any issues or trouble, please don't hesitate to get in touch.