Speckle currently supports versions: .
The connector works on only.
Setup
The Rhino and Grasshopper connectors are bundled, so if you installed one, you don’t need to install the other.
1
Install the connector
Install your connector
2
Open the Grasshopper connector
- Open Grasshopper, and select the Speckle tab in the ribbon.
- If you’ve already signed in from any Speckle connector, skip the next step.
3
Connect your Speckle account
- If you’ve already signed in from any Speckle connector, skip this step.
- Add the Sign-In node to the canvas, and click Sign in.
- Complete the sign in process in your web browser.
You only need to sign in to an account once from any Speckle connector.
To switch accounts in Grasshopper, you can select the correct account by right-clicking the Speckle Model URL node.
Why is the Speckle plugin not showing up after I installed the connector?
Why is the Speckle plugin not showing up after I installed the connector?
- Make sure your version of is one of the supported versions.
- Uninstall and reinstall your connector.
.exe or right-clicking and then selecting Open to run the installer.
Installation issues can also be caused by conflicting plugins.If you’re still experiencing problems, please report it in our Community Forum and include the following information:- Your application version
- Your Speckle connector version
What should I do if the plugin UI is empty or unresponsive, or if my application crashes?
What should I do if the plugin UI is empty or unresponsive, or if my application crashes?
If your connector window is floating, try docking it to your application to fix blank UI issues.For major issues, you can sometimes find a
log file in your directory at AppData\Roaming\Speckle\Logs.
Please report your problem in our Community Forum and include the following information:- Your application version
- Your Speckle connector version
- A copy of the log
Why can't I add a new account?
Why can't I add a new account?
This can happen if our desktop service isn’t running. Desktop Service is used for authenticating new accounts. If it’s not running, search for Speckle Desktop Services in Windows search and run it.
How do I uninstall my connector?
How do I uninstall my connector?
All Speckle connectors are installed like any other program. You can uninstall them directly from your system’s
Applications. For a full uninstall, you should also remove Speckle Desktop Services as well as your Speckle connector.How do I update my connector to the latest version?
How do I update my connector to the latest version?
You can always download the latest version of the connector in the web app.
If a new version of the connector is available, you will also see a notification in your connector UI.
Getting Started
Template File: Download our Grasshopper template file to get started quickly with common Speckle nodes and workflows.
Publishing a Model
Sample Files: Full documentation of all Grasshopper nodes and sample scripts is installed with your connector.
Navigate to File > Special Folders > Components Folder > Speckle Sample Files in Grasshopper to find them.Template File: For a quick start, download our Grasshopper template file with common Speckle nodes and workflows.
1
Create a Collection with objects
- Add a Create Collection node from the
Collectionscategory to the canvas. - Connect the geometry you want to publish to the input of the Create Collection node.
2
Get your Speckle model link
- Add a Speckle Model URL node to the canvas.
- Choose a project:
- Click on the Project button to select a project from the dropdown
- or use the search bar to find another project.
- Choose a model:
- Click on the Model button to select a model from the dropdown
- or use the search bar to find another model.
3
Publish your model
- Add a Publish node to the canvas and connect your inputs:
- Add your Create Collection output to the Collection input.
- Add your Speckle Model URL output to the Model Link input.
- Click Publish. Your model is now published to Speckle and is available to the rest of your team.
How do I create properties by key-value, instead of using the Create Properties node?
How do I create properties by key-value, instead of using the Create Properties node?
You can use the Speckle Properties passthrough node to create properties by key-value.
How do I sync my property and collection names with their inputs?
How do I sync my property and collection names with their inputs?
If you keep your params organized with their own names, then you can easily inherit these names when using the Create Properties or Create Collection nodes.
To sync individual input names:
- Hold down the TAB key when plugging in your input property, objects, or collection. To automatically sync all input names:
- Right-click the Create Properties or Create Collection node.
- Select Inherit all names. The Inherit all names option will lock input name editing and always keep your input names synced with their sources.
How do I create new projects or models to publish to?
How do I create new projects or models to publish to?
Currently, it’s not possible to create new projects or models in Grasshopper.
You can right-click your Speckle model to open it in your web browser.
All project management should be done in your web browser.
Can I create specific objects for other applications like Revit or ETABs?
Can I create specific objects for other applications like Revit or ETABs?
You can create Data Objects which are a simplified version of the objects that are published from other connectors.
If you assign a builtInCategory property to a Data Object, it will be loaded as a generic model with that category in Revit.
However, there is currently no way to create elements that will be received as native types like walls and beams in BIM or structural applications.
How do I change my account?
How do I change my account?
Right-click your Speckle Model node and select Change accounts to change your account.
Loading a Model
Sample Files: Full documentation of all Grasshopper nodes and sample scripts is installed with your connector.
Navigate to File > Special Folders > Components Folder > Speckle Sample Files in Grasshopper to find them.Template File: For a quick start, download our Grasshopper template file with common Speckle nodes and workflows.
1
Get your Speckle model link
- Add a Speckle Model URL node to the canvas.
- Choose a project:
- Click on the Project button to select a project from the dropdown
- or use the search bar to find another project.
- Choose a model:
- Click on the Model button to select a model from the dropdown
- or use the search bar to find another model.
- Choose a version:
- Latest version is loaded by default.
- To load a specific version, click on the Version button and select.
2
Load your model
- Add a Load node to the canvas and connect your input:
- Add your Speckle Model URL output to the Model Link input.
- Click Load. Your selected model version is now loaded in Grasshopper.
3
Get your model objects
- Add a Query objects node to the canvas and connect your input:
- Add your Load output to the collection input.
- You can now work with your loaded objects in Grasshopper.
How do I access object fields that I see in the web browser, but that are not in my Grasshopper object properties?
How do I access object fields that I see in the web browser, but that are not in my Grasshopper object properties?
If you want to access geometry properties like what you would see in dev mode in your browser, you can use the Deconstruct node.
Can I load a model via URL?
Can I load a model via URL?
Yes. Copy your URL to a Panel and connect it to your Speckle Model URL node.
How do I change my account?
How do I change my account?
Right-click your Speckle Model URL node and select Change accounts to change your account.