Skip to content

Commit

Permalink
doc: minor documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ntamas committed Dec 19, 2024
1 parent 9d7ec1e commit 9f2cd18
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 11 deletions.
8 changes: 4 additions & 4 deletions doc/modules/ROOT/pages/install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ image::install_blender_addons.jpg[Install Blender Add-ons]

6. Setup add-on preferences if you are using a version of *Skybrush Studio for Blender* other than the free community edition:

API Key:: If you have received an API Key for communicating with the Skybrush Studio server, paste it here.
API key:: If you have received an API key for communicating with the Skybrush Studio server, paste it here.

License file:: If you have received a License file for communicating with the Skybrush Studio server, give its full path here to use it as your API Key.
License file:: If you have received a license file for communicating with the Skybrush Studio server, give its full path here to use it as your API Key.

Server URL:: Enter the URL of a dedicated Skybrush Studio server if you are using a dedicated server.
Server URL:: Enter the URL of a dedicated Skybrush Studio server if you are using a dedicated server. You can also click on the btn:[Use local server] button to use a server that is running on your own machine.

=== 4. Enable Online Access in Blender

Expand All @@ -58,7 +58,7 @@ If you are a community user, you do _not_ need to install the *Skybrush Studio S

==== 5.2 Cloud server for pro users

If you are using a paid, professional version of *Skybrush Studio*, you will receive a license file upon purchase of the software. This license file shall be used as an API key that enables your pro features while using the cloud-based *Skybrush Studio Server* (see setup instructions above on how to use your License file as your API Key).
If you are using a paid, professional version of *Skybrush Studio*, you will receive a license file upon purchase of the software. This license file shall be used as an API key that enables your pro features while using the cloud-based *Skybrush Studio Server* (see setup instructions above on how to use your license file as your API Key).

==== 5.3 Local server for VIP users

Expand Down
12 changes: 6 additions & 6 deletions doc/modules/ROOT/pages/panels/safety_and_export/export.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The Skybrush compiled show format is a single-file descriptor of your complete d
* If you want to execute your drone show on your real drones, use *Skybrush Live*.
If you press the btn:[Export to .skyc] button, you have to choose the path and filename of your output file. There are also some parameters you can setup conveniently:
If you press the btn:[Export Skybrush SKYC] button, you have to choose the path and filename of your output file. There are also some parameters you can setup conveniently:
Export selected drones only:: Export all or only selected drones
Expand All @@ -30,13 +30,13 @@ Light FPS:: Set the output frame rate for light programs (make sure it is a subm
Export yaw:: Enable this checkbox to output rotations around the yaw (vertical) axis of your drone objects into the .skyc file
== Export to .csv
== Export to CSV
The trajectories and LED light colors of the drones can also be sampled at regular intervals and exported to CSV files for further post-processing in external tools. This option appears only if you have installed and enabled the CSV export addon that is distributed separately. The CSV export will produce a single ZIP file that contains multiple CSV files, one for each drone, with the following columns: time (milliseconds), X, Y and Z coordinates (meters) and the red, green and blue components of the color of the LED light, in the usual 0-255 range.
TIP: We recommend using Skybrush Live for drone show control, together with the official Skybrush Compiled Format (.skyc), as it contains a lot more information about your show in a more optimized way than this simple CSV representation.
If you press the btn:[Export to .skyc] button, you have to choose the path and filename of your output file. There are also some parameters you can setup conveniently:
If you press the btn:[Export Skybrush CSV] button, you have to choose the path and filename of your output file. There are also some parameters you can setup conveniently:
Export selected drones only:: Export all or only selected drones
Expand All @@ -47,9 +47,9 @@ Frame rate:: Set output frame rate of drone trajectories and light programs (mak
NOTE: Special characters in drone names are converted to standard characters in the exported filenames.
== Export to validation .pdf
== Export validation report
The btn:[Export to validation .pdf] button creates a unique safety report of your show in .pdf format for standalone self-checking, validated reporting or as a supplement for flight permissions or other administration purposes.
The btn:[Export validation report] button creates a unique safety report of your show in .pdf format for standalone self-checking, validated reporting or as a supplement for flight permissions or other administration purposes.
The validation report starts with a summary of flight statistics and safety test results, and continues with detailed plots on all aspects of the implemented safety checks.
Expand All @@ -58,7 +58,7 @@ The validation report starts with a summary of flight statistics and safety test
The validation .pdf is created by a local or remote instance of *Skybrush Studio Server* running in the background. As creating the validation report is resource intensive, access to this feature might be disabled on our public server and might be only available through a paid license option. If you need but do not have access, mailto:[email protected][contact us] for obtaining the proper *Skybrush Studio Server* license.
****
If you press the btn:[Export to validation .pdf] button, you have to choose the path and filename of your output file. There are also some parameters you can setup conveniently:
If you press the btn:[Export validation report] button, you have to choose the path and filename of your output file. There are also some parameters you can setup conveniently:
Export selected drones only:: Export all or only selected drones
Expand Down
6 changes: 5 additions & 1 deletion src/modules/sbstudio/api/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,11 @@ class SkybrushStudioAPI:
server.
"""

_api_key: Optional[str] = None
"""The API key that will be submitted with each request. For license-type
API keys, the key must start with the string "License ".
"""

_root: str
"""The root URL of the API, with a trailing slash"""

Expand Down Expand Up @@ -153,7 +158,6 @@ def __init__(
api_key: the API key used to authenticate with the server
license_file: the path to a license file to be used as the API Key
"""
self._api_key = None
self._root = None # type: ignore
self._request_context = create_default_context()

Expand Down

0 comments on commit 9f2cd18

Please sign in to comment.