Skip to content

Commit

Permalink
plugin ID change (yes, I'm insane)
Browse files Browse the repository at this point in the history
  • Loading branch information
juliarobles committed Apr 15, 2024
1 parent e7e38b5 commit 9b6dbe6
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 17 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Unity WebGL Grafana panel plugin
# Unity panel plugin

This plugin provides a solution to render Unity WebGL builds directly inside a Grafana panel, allowing its integration into any dashboard. It also enables a bi-directional interaction between Grafana and Unity. This means that the Unity build can take advantage of data coming from Grafana data sources, and in turn, the running build can send data to the dashboard, affecting the rest of the dashboard. Of course, if the Unity compilation allows users to interact with it, this functionality will still be possible even if it is within a Grafana dashboard. Although it was originally designed as an extension to [OpenTwins](https://github.com/ertis-research/opentwins), our digital twin platform, it has no dependency on it, making it a versatile tool suitable for a variety of scenarios.

Expand Down
10 changes: 5 additions & 5 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: '3.0'
services:
grafana:
user: root
container_name: 'ertis-3-d-visualization-unity'
container_name: 'ertis-unity-panel'

platform: 'linux/amd64'
build:
Expand All @@ -14,13 +14,13 @@ services:
ports:
- 3000:3000/tcp
volumes:
- ./dist:/var/lib/grafana/plugins/ertis-3-d-visualization-unity
- ./dist:/var/lib/grafana/plugins/ertis-unity-panel
- ./provisioning:/etc/grafana/provisioning
- .:/root/ertis-3-d-visualization-unity
- .:/root/ertis-unity-panel

environment:
NODE_ENV: development
GF_LOG_FILTERS: plugin.ertis-3-d-visualization-unity:debug
GF_LOG_FILTERS: plugin.ertis-unity-panel:debug
GF_LOG_LEVEL: debug
GF_DATAPROXY_LOGGING: 1
GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: ertis-3-d-visualization-unity
GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: ertis-unity-panel
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "ertis-3-d-visualization-unity",
"name": "ertis-unity-panel",
"version": "1.0.0",
"description": "3d visualization using unity",
"description": "Unity WebGL render in Grafana panel",
"scripts": {
"build": "webpack -c ./.config/webpack/webpack.config.ts --env production",
"dev": "webpack -w -c ./.config/webpack/webpack.config.ts --env development",
Expand Down
8 changes: 4 additions & 4 deletions src/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export const plugin = new PanelPlugin<SimpleOptions>(UnityPanel).setPanelOptions
.addStringArray({
path: 'fields_to_send',
name: 'Fields to send',
description: 'List of fields to be sent to the Unity model. If this field is not filled in, all available fields will be sent.',
description: 'List of fields to be sent to the Unity build. If this field is not filled in, all available fields will be sent.',
defaultValue: [],
category: ['Data options']
})
Expand Down Expand Up @@ -64,15 +64,15 @@ export const plugin = new PanelPlugin<SimpleOptions>(UnityPanel).setPanelOptions
})
.addTextInput({
path: 'folderUnityBuild',
name: 'Folder with Unity model',
description: 'Name of the folder that contains the Unity model files built in WebGL that we want to display. This should be inside the grafana public/unitybuild folder.',
name: 'Folder with Unity build',
description: 'Name of the folder that contains the Unity WebGL build files that we want to display. This should be inside the grafana public/unitybuild folder.',
defaultValue: 'raspberry',
category: ['Unity options']
})
.addTextInput({
path: 'nameOfFilesUnityBuild',
name: 'Unity build file names',
description: 'Name of the files obtained as a result of compiling the Unity model in WebGL. There must be 4 files with the same name and extensions: .data, .framework, .loader and .wasm. They must be contained in the folder specified in the previous field.',
description: 'Name of the files obtained as a result of compiling the Unity project in WebGL. There must be 4 files with the same name and extensions: .data, .framework, .loader and .wasm. They must be contained in the folder specified in the previous field.',
defaultValue: 'myunityapp',
category: ['Unity options']
})
Expand Down
11 changes: 6 additions & 5 deletions src/plugin.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
{
"$schema": "https://raw.githubusercontent.com/grafana/grafana/master/docs/sources/developers/plugins/plugin.schema.json",
"type": "panel",
"name": "Unity model",
"id": "ertis-3-d-visualization-unity",
"name": "Unity",
"id": "ertis-unity-panel",
"info": {
"description": "3d visualization using unity",
"description": "Unity WebGL render in Grafana panel",
"author": {
"name": "ERTIS",
"url": ""
"url": "https://ertis.uma.es/"
},
"keywords": [
"unity",
"3d"
"3D",
"webGL"
],
"logos": {
"small": "img/logo.svg",
Expand Down

0 comments on commit 9b6dbe6

Please sign in to comment.