Plugin cleaned for publishing

integrations/blender/Plugin page/description.md

@@ -0,0 +1,78 @@
+# 3D radio simulation in Blender
+
+**NOTE: Requires a premium CloudRF account**
+
+Interface to the 3D simulation API at CloudRF.com. This powerful full 3D API supports configurable radios and antennas as well as the following features:
+
+* Reflections
+* Material attenuation
+* Material diffusion
+* 10cm resolution
+
+## API reference
+
+https://cloudrf.com/documentation/developer/#/3D
+
+## API access
+
+Access to the CloudRF account is available to Silver and Gold customers who have purchased a plan. Pay as you go and subscriptions available:
+
+https://cloudrf.com/plans
+
+## Command line Hello World!
+
+A command line API demo for this API is available on Github:
+
+https://github.com/Cloud-RF/CloudRF-API-clients/tree/master/bash/3d
+
+
+## Overview
+
+It POSTs a blender scene to the [model upload API](https://cloudrf.com/documentation/developer/#/3D/3dModelUpload), then POSTs a JSON request containing radio settings to the [3D API](https://cloudrf.com/documentation/developer/#/3D/3d). 
+
+Results are loaded upon the scene as a GLB file.
+
+## How to install
+
+- Install the plugin by selecting "Edit" > "Preferences" > "Add-ons". Then click on the button to "Install...". Locate the Python script.
+- It will show "Import-Export: CloudRF". Check the box to enable it.
+- Close the "Blender Preferences" window.
+
+## How to use
+
+This works best with simple meshes but can work with complex meshes like Google photorealistic models sourced via the BLOSM plugin.
+The more complex the mesh, the longer it takes.
+
+Extreme models eg. London at 10cm, are reduced automatically at the API to fit inside a Megavoxel limit linked to your plan. The silver plan is 10MP at the time of writing.
+
+### Add a transmitter
+
+- Add transmitters to your environment from the "Layout" display by clicking on "Add" at the top of the screen, then hover over "Transmitters" and choose a 2.2GHz template radio.
+
+- To move a transmitter, use Blender's Move tool from the top left toolbox. This will show colour coded X/Y/Z planes which you can drag to move the transmitter in three dimensions. 
+
+- Transmitter Properties like power, antenna gain etc can be configured in the data tab in the properties area, located in the bottom right of the screen
+
+
+### Simulating RF coverage
+
+- On your keyboard press the "N" button to pull out a dialogue window from the top right of the screen. To the right of the dialogue window is a tab labelled as "CloudRF". Click on this.
+- Enter your API Key into the "API Key" box.
+- Click "Upload model" to send your model to your account. Be patient as this upload could take a while.
+- Click "Simulate" to simulate coverage. A small model takes seconds and a large model can take several minutes.
+- Your result will be automatically displayed in the viewer.
+- Watch the "Blender Info Log" for any errors or information. These will display at the bottom of your screen when they occur. For example "Calculation already in progress, please wait"
+
+NOTE: This is resource intensive so your account can only run one job at a time. You will need to wait if a job is still in process.
+
+### Importing radio templates
+
+- Obtain a JSON template with your desired radio settings. Examples can be found (here)[https://github.com/Cloud-RF/CloudRF-API-clients/tree/master/templates].
+- Under the "CloudRF" panel in the dialogue window, locate the Import Template tab.
+- Click the "Browse" button to locate the JSON file location for the template to be loaded from.
+- Click "Import".
+- This will add a new transmitter template to the add transmitters menu.
+
+
+
+

integrations/blender/CloudRF_3D.py → integrations/blender/__init__.py

@@ -13,8 +13,8 @@
     "name": "CloudRF 3D",
     "description": "Simulate RF propagation using the CloudRF 3D API",
     "author": "CloudRF.com",
-    "version": (1, 0),
-    "blender": (3, 0, 0),
+    "version": (1, 0, 1),
+    "blender": (3, 6, 0),
     "category": "Import-Export"
 }
 

integrations/blender/blender_manifest.toml

@@ -0,0 +1,52 @@
+schema_version = "1.0.0"
+
+# Example of manifest file for a Blender extension
+# Change the values according to your extension
+id = "CloudRF_3D"
+version = "1.0.1"
+name = "CloudRF 3D API plugin"
+tagline = "Perform full 3D RF simulation direct from Blender"
+maintainer = "CloudRF <[email protected]>"
+# Supported types: "add-on", "theme"
+type = "add-on"
+
+# Optional link to documentation, support, source files, etc
+# website = "https://extensions.blender.org/add-ons/my-example-package/"
+
+# Optional list defined by Blender and server, see:
+# https://docs.blender.org/manual/en/dev/advanced/extensions/tags.html
+tags = ["Animation", "Sequencer"]
+
+blender_version_min = "4.2.0"
+# # Optional: Blender version that the extension does not support, earlier versions are supported.
+# # This can be omitted and defined later on the extensions platform if an issue is found.
+# blender_version_max = "5.1.0"
+
+# License conforming to https://spdx.org/licenses/ (use "SPDX: prefix)
+# https://docs.blender.org/manual/en/dev/advanced/extensions/licenses.html
+license = [
+  "SPDX:GPL-2.0-or-later",
+]
+# Optional: required by some licenses.
+ copyright = [
+   "2024 Farrant Consulting Ltd T/A CloudRF"
+ ]
+
+# # Optional: add-ons can list which resources they will require:
+# # * files (for access of any filesystem operations)
+# # * network (for internet access)
+# # * clipboard (to read and/or write the system clipboard)
+# # * camera (to capture photos and videos)
+# # * microphone (to capture audio)
+# #
+# # If using network, remember to also check `bpy.app.online_access`
+# # https://docs.blender.org/manual/en/dev/advanced/extensions/addons.html#internet-access
+# #
+# # For each permission it is important to also specify the reason why it is required.
+# # Keep this a single short sentence without a period (.) at the end.
+# # For longer explanations use the documentation or detail page.
+#
+[permissions]
+network = "Needed to communicate with the CloudRF API"
+files = "Needed to save and load a GLB model"
+