BlueOS Extension for Water Linked Underwater GPS
\nState
\nThis extension has no UI page (so it creates no listing in the sidebar of BlueOS).
\nFunctionality
\nAssuming the UGPS is detected and working, this service\n* forwards MAVLink data from Mavlink2Rest like depth to the UGPS Topside (to enable it to function)\n* forwards locator position from UGPS Topside to MAVLink (message GPS_INPUT)\n * the autopilot should send corresponding GPS_RAW_INT messages to the topside computer (QGroundControl)\n * the autopilot sends regular GLOBAL_POSITION_INT messages to the topside computer with its filtered position estimates\n* forwards topside position from UGPS Topside to UDP port 14401 with NMEA to be received by QGroundControl.\n * This feature is experimental and does not work reliably with all versions of QGroundControl.
Information flow triggered by this extension:\n![\"Information](\"https://raw.githubusercontent.com/waterlinked/blueos-ugps-extension/v1.0.7/./docs/extension_information_flow.svg\"/)
If you do not have access to a UGPS system, you can use UGPS_HOST=https://demo.waterlinked.com , which simulates a UGPS system with its API.
\nHardware documentation can be found at https://waterlinked.github.io/underwater-gps/integration/bluerov-integration/
\nHow to install
\nThere are 2 options
\nPreferred: Use the extensions manager in BlueOS > 1.1.0
\n- \n
- Click Extensions > Extensions Manager \n
- Install this extension \n
Configuration is usually not required, but can be done by editing the extension in the \"Installed\" tab of the Extensions Manager.
\nEditing requires Pirate Mode\nto be enabled, after which the \"Edit\" button can be used. Copy the Original Settings contents\ninto the Custom settings box, and (if necessary) change the IPs/Host addresses, e.g. to use the demo server:\n{\n \"NetworkMode\": \"host\",\n \"Env\": [\n \"UGPS_HOST=https://demo.waterlinked.com\",\n \"MAVLINK_HOST=http://192.168.2.2:6040\",\n \"QGC_IP=192.168.2.1\",\n \"EXTRA_ARGS=\"\n ]\n}
Use the \"View Logs\" button to check the status.
\nFor developers: Build docker image yourself and start it
\nTo set this up, ssh into the Raspberry Pi (or access via red-pill in BlueOS Terminal)
install git, clone this repository and run\n```
\nbuild the docker image
\ndocker build -t waterlinked/blueos-ugps-extension:latest .
\nsee all images
\ndocker images
\nrunning the plugin
\neither: run detached
\nwith standard command
\ndocker run -d --net=host waterlinked/blueos-ugps-extension:latest python app/main.py --ugps_host http://192.168.2.94 --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nor with demo server
\ndocker run -d --net=host waterlinked/blueos-ugps-extension:latest python app/main.py --ugps_host https://demo.waterlinked.com --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nor: in interactive shell to get debug output
\ndocker run -it waterlinked/blueos-ugps-extension:latest /bin/bash
\nwith standard command
\ncd app && python main.py --ugps_host http://192.168.2.94 --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nor with demo server
\ncd app && python main.py --ugps_host https://demo.waterlinked.com --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nend interactive session
\nexit
\nthen stop/start/look at log with
\ndocker stop [container-id]\ndocker start [container-id]\ndocker log [container-id] # if run detached
\nif you are a developer, upload the docker image to registry with (replace \"latest\" with desired tag)
\ndocker login -u waterlinked\ndocker push waterlinked/blueos-ugps-extension:latest\n```
", "support": "https://github.com/waterlinked/blueos-ugps-extension/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Water Linked", "email": "support@waterlinked.com" }, "permissions": { "NetworkMode": "host", "Env": [ "UGPS_HOST=http://192.168.2.94", "MAVLINK_HOST=http://192.168.2.2:6040", "QGC_IP=192.168.2.1", "EXTRA_ARGS=" ] } }, "v1.0.7-beta.5": { "identifier": "ec530e8b-3edb-5204-8ec3-7ab95a2548aa", "type": "device-integration", "website": "https://github.com/waterlinked/blueos-ugps-extension", "images": [ { "expanded_size": 45409796, "platform": { "architecture": "arm", "variant": "v5", "os": "linux" }, "digest": "sha256:a3e5dd741d7c259f42e53ae660aaba0a4c4ea809bac829a8bf7ddf9f08488027" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [ "positioning", "navigation", "short-baseline" ], "extra_links": {}, "tag": "v1.0.7-beta.5", "docs": null, "readme": "No README available", "support": "https://github.com/waterlinked/blueos-ugps-extension/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Water Linked", "email": "support@waterlinked.com" }, "permissions": { "NetworkMode": "host", "Env": [ "UGPS_HOST=http://192.168.2.94", "MAVLINK_HOST=http://192.168.2.2:6040", "QGC_IP=192.168.2.1", "EXTRA_ARGS=" ] } }, "v1.0.7-beta.2": { "identifier": "01960110-d3b4-5ec9-b831-fc6ed5504c76", "type": "device-integration", "website": "https://github.com/waterlinked/blueos-ugps-extension", "images": [ { "expanded_size": 42996077, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:827ca6180221c282ced1a2c58e02388c1cf1b4eb87cca1604355a90bf0b81293" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [ "positioning", "navigation", "short-baseline" ], "extra_links": {}, "tag": "v1.0.7-beta.2", "docs": null, "readme": "BlueOS Extension for Water Linked Underwater GPS
\nState
\nThis extension has no UI page (so it creates no listing in the sidebar of BlueOS).
\nFunctionality
\nAssuming the UGPS is detected and working, this service\n* forwards MAVLink data from Mavlink2Rest like depth to the UGPS Topside (to enable it to function)\n* forwards locator position from UGPS Topside to MAVLink (message GPS_INPUT)\n * the autopilot should send corresponding GPS_RAW_INT messages to the topside computer (QGroundControl)\n * the autopilot sends regular GLOBAL_POSITION_INT messages to the topside computer with its filtered position estimates\n* forwards topside position from UGPS Topside to UDP port 14401 with NMEA to be received by QGroundControl.\n * This feature is experimental and does not work reliably with all version of QGroundControl.
If you do not have access to a UGPS system, you can use UGPS_HOST=https://demo.waterlinked.com , which simulates a UGPS system with its API.
\nHardware documentation can be found at https://waterlinked.github.io/underwater-gps/integration/bluerov-integration/
\nHow to install
\nThere are 2 options
\nPreferred: Use the extensions manager in BlueOS > 1.1.0
\n- \n
- Click Extensions > Extensions Manager \n
- Install this extension \n
Configuration is usually not required, but can be done by editing the extension in the \"Installed\" tab of the Extensions Manager.
\nEditing requires Pirate Mode\nto be enabled, after which the \"Edit\" button can be used. Copy the Original Settings contents\ninto the Custom settings box, and (if necessary) change the IPs/Host addresses, e.g. to use the demo server:\n{\n \"NetworkMode\": \"host\",\n \"Env\": [\n \"UGPS_HOST=https://demo.waterlinked.com\",\n \"MAVLINK_HOST=http://192.168.2.2:6040\",\n \"QGC_IP=192.168.2.1\",\n \"EXTRA_ARGS=\"\n ]\n}
Use the \"View Logs\" button to check the status.
\nFor developers: Build docker image yourself and start it
\nTo set this up, ssh into the Raspberry Pi (or access via red-pill in BlueOS Terminal)
install git, clone this repository and run\n```
\nbuild the docker image
\ndocker build -t waterlinked/blueos-ugps-extension:latest .
\nsee all images
\ndocker images
\nrunning the plugin
\neither: run detached
\nwith standard command
\ndocker run -d --net=host waterlinked/blueos-ugps-extension:latest python app/main.py --ugps_host http://192.168.2.94 --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nor with demo server
\ndocker run -d --net=host waterlinked/blueos-ugps-extension:latest python app/main.py --ugps_host https://demo.waterlinked.com --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nor: in interactive shell to get debug output
\ndocker run -it waterlinked/blueos-ugps-extension:latest /bin/bash
\nwith standard command
\ncd app && python main.py --ugps_host http://192.168.2.94 --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nor with demo server
\ncd app && python main.py --ugps_host https://demo.waterlinked.com --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nend interactive session
\nexit
\nthen stop/start/look at log with
\ndocker stop [container-id]\ndocker start [container-id]\ndocker log [container-id] # if run detached
\nif you are a developer, upload the docker image to registry with (replace \"latest\" with desired tag)
\ndocker login -u waterlinked\ndocker push waterlinked/blueos-ugps-extension:latest\n```
", "support": "https://github.com/waterlinked/blueos-ugps-extension/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Water Linked", "email": "support@waterlinked.com" }, "permissions": { "NetworkMode": "host", "Env": [ "UGPS_HOST=http://192.168.2.94", "MAVLINK_HOST=http://192.168.2.2:6040", "QGC_IP=192.168.2.1", "EXTRA_ARGS=" ] } }, "v1.0.6": { "identifier": "a16ae9c5-eeb8-5263-8b1c-0401b0a1e2da", "type": "device-integration", "website": "https://github.com/waterlinked/blueos-ugps-extension", "images": [ { "expanded_size": 44982471, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:d1c746dac6246d215f00966754129fb78375c1e98bba95d9a0f3a165a2522805" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [ "positioning", "navigation", "short-baseline" ], "extra_links": {}, "tag": "v1.0.6", "docs": null, "readme": "BlueOS Extension for Water Linked Underwater GPS
\nState
\nThis extension is currently in development. It has no UI page (so creates no listing in the sidebar of BlueOS).
\nFunctionality
\nAssuming the UGPS is detected and working this service\n* forwards MAVLink data from Mavlink2Rest like depth to the UGPS Topside (to enable it to function)\n* forwards locator position from UGPS Topside to MAVLink (message GPS_INPUT)\n * the autopilot should send corresponding GPS_RAW_INT messages to the topside computer (QGroundControl)\n * the autopilot sends regular GLOBAL_POSITION_INT messages to the topside computer with its filtered position estimates\n* forwards topside position from UGPS Topside to UDP port 14401 with NMEA to be received by QGroundControl.
If you do not have access to a UGPS system, you can use UGPS_HOST=https://demo.waterlinked.com , which simulates a UGPS system with its API.
\nHardware documentation can be found at https://waterlinked.github.io/underwater-gps/integration/bluerov-integration/
\nHow to install
\nThere are 2 options
\nUse the extensions manager in BlueOS 1.1.0
\n- \n
- Click Extensions > Extensions Manager \n
- Install this extension \n
Configuration is usually not required, but can be done by editing the extension in the \"Installed\" tab of the Extensions Manager.
\nEditing requires Pirate Mode\nto be enabled, after which the \"Edit\" button can be used. Copy the Original Settings contents\ninto the Custom settings box, and (if necessary) change the IPs/Host addresses, e.g. to use the demo server:\n{\n \"NetworkMode\": \"host\",\n \"Env\": [\n \"UGPS_HOST=https://demo.waterlinked.com\",\n \"MAVLINK_HOST=http://192.168.2.2:6040\",\n \"QGC_IP=192.168.2.1\",\n \"EXTRA_ARGS=\"\n ]\n}
Use the \"View Logs\" button to check the status.
\nBuild docker image yourself and start it
\nTo set this up, ssh into the Raspberry Pi (or access via red-pill in BlueOS Terminal)
install git, clone this repository and run\n```
\nbuild the docker image
\ndocker build -t waterlinked/blueos-ugps-extension:latest .
\nsee all images
\ndocker images
\nrunning the plugin
\neither: run detached
\nwith standard command
\ndocker run -d --net=host waterlinked/blueos-ugps-extension:latest python app/main.py --ugps_host http://192.168.2.94 --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nor with demo server
\ndocker run -d --net=host waterlinked/blueos-ugps-extension:latest python app/main.py --ugps_host https://demo.waterlinked.com --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nor: in interactive shell to get debug output
\ndocker run -it waterlinked/blueos-ugps-extension:latest /bin/bash
\nwith standard command
\ncd app && python main.py --ugps_host http://192.168.2.94 --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nor with demo server
\ncd app && python main.py --ugps_host https://demo.waterlinked.com --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nend interactive session
\nexit
\nthen stop/start/look at log with
\ndocker stop [container-id]\ndocker start [container-id]\ndocker log [container-id] # if run detached
\nif you are a developer, upload to registry with (replace latest with desired tag)
\ndocker login -u waterlinked\ndocker push waterlinked/blueos-ugps-extension:latest\n```
", "support": "https://github.com/waterlinked/blueos-ugps-extension/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Water Linked", "email": "support@waterlinked.com" }, "permissions": { "NetworkMode": "host", "Env": [ "UGPS_HOST=http://192.168.2.94", "MAVLINK_HOST=http://192.168.2.2:6040", "QGC_IP=192.168.2.1", "EXTRA_ARGS=" ] } }, "v1.0.4": { "identifier": "07593b5f-33d9-512b-92e7-bde2b70e0c1a", "type": "other", "website": "https://github.com/waterlinked/blueos-ugps-extension", "images": [ { "expanded_size": 43100109, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:55811587b48ae3f980fa069e27d74c11a98567bd141eb2cb29cd3a0a43c39526" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [], "extra_links": {}, "tag": "v1.0.4", "docs": "", "readme": "BlueOS Extension for Water Linked Underwater GPS
\nState
\nThis extension is currently in development. It has no UI page (so creates no listing in the sidebar of BlueOS).
\nFunctionality
\nAssuming the UGPS is detected and working this service\n* forwards MAVLink data from Mavlink2Rest like depth to the UGPS Topside (to enable it to function)\n* forwards locator position from UGPS Topside to MAVLink (message GPS_INPUT)\n * the autopilot should send corresponding GPS_RAW_INT messages to the topside computer (QGroundControl)\n * the autopilot sends regular GLOBAL_POSITION_INT messages to the topside computer with its filtered position estimates\n* forwards topside position from UGPS Topside to UDP port 14401 with NMEA to be received by QGroundControl (implemented, but currently not tested)
If you do not have access to a UGPS system, you can use UGPS_HOST=https://demo.waterlinked.com , which simulates a UGPS system with its API.
\nHardware documentation can be found at https://waterlinked.github.io/underwater-gps/integration/bluerov-integration/
\nHow to install
\nThere are 2 options
\nUse the extensions manager in BlueOS 1.1.0
\n- \n
- Click Extensions > Extensions Manager \n
- Install this extension \n
Configuration is usually not required, but can be done by editing the extension in the \"Installed\" tab of the Extensions Manager.
\nEditing requires Pirate Mode\nto be enabled, after which the \"Edit\" button can be used. Copy the Original Settings contents\ninto the Custom settings box, and (if necessary) change the IPs/Host addresses:\n\"UGPS_HOST=http://192.168.2.94\",\n \"MAVLINK_HOST=http://192.168.2.2:6040\",\n \"QGC_IP=192.168.2.1\"
Use the \"View Logs\" button to check the status.
\nBuild docker image yourself and start it
\nTo set this up, ssh into the Raspberry Pi (or access via red-pill in BlueOS Terminal)
install git, clone this repository and run\n```
\nbuild the docker image
\ndocker build -t waterlinked/blueos-ugps-extension:latest .
\nsee all images
\ndocker images
\nrunning the plugin
\neither: run detached
\nwith standard command
\ndocker run -d --net=host waterlinked/blueos-ugps-extension:latest python app/main.py --ugps_host http://192.168.2.94 --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nor with demo server
\ndocker run -d --net=host waterlinked/blueos-ugps-extension:latest python app/main.py --ugps_host https://demo.waterlinked.com --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nor: in interactive shell to get debug output
\ndocker run -it waterlinked/blueos-ugps-extension:latest /bin/bash
\nwith standard command
\ncd app && python main.py --ugps_host http://192.168.2.94 --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nor with demo server
\ncd app && python main.py --ugps_host https://demo.waterlinked.com --mavlink_host http://192.168.2.2:6040 --qgc_ip 192.168.2.1
\nend interactive session
\nexit
\nthen stop/start/look at log with
\ndocker stop [container-id]\ndocker start [container-id]\ndocker log [container-id] # if run detached
\nif you are a developer, upload to registry with (replace latest with desired tag)
\ndocker login -u waterlinked\ndocker push waterlinked/blueos-ugps-extension:latest\n```
", "support": "https://github.com/waterlinked/blueos-ugps-extension", "requirements": "core >= 1", "company": { "about": "", "name": "Blue Robotics / Water Linked", "email": "support@bluerobotics.com / support@waterlinked.com" }, "permissions": { "NetworkMode": "host", "Env": [ "UGPS_HOST=http://192.168.2.94", "MAVLINK_HOST=http://192.168.2.2:6040", "QGC_IP=192.168.2.1" ] } } }, "repo_info": { "downloads": 12935, "last_updated": "2024-10-16T08:28:28.588962Z", "date_registered": "2023-04-18T13:14:56.444696Z" } }, { "identifier": "deepwaterexploration.dwe_os_2", "name": "DWE OS 2.0", "website": "https://github.com/DeepwaterExploration/DWE_OS_2", "docker": "deepwaterexploration/dwe_os_2", "description": "Web-based driver and software interface for DWE.ai cameras", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/deepwaterexploration/dwe_os_2/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/deepwaterexploration/company_logo.png", "versions": { "v0.5.1-asic": { "identifier": "3400c2ef-956b-54e4-ab07-f4e1593263a6", "type": "device-integration", "website": null, "images": [ { "expanded_size": 412449373, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:61ca0181df553eefc3a7300faa38d0d8cfee8ad2a40b616a4176fe67648ec8c9" } ], "authors": [ { "name": "Brandon Stevens", "email": "support@dwe.ai" } ], "filter_tags": [ "cameras", "dwe-ai", "exporehd", "stellarhd", "deepwater-exploration" ], "extra_links": {}, "tag": "v0.5.1-asic", "docs": null, "readme": "DWE_OS 2.0
\nDWE_OS is an optional piece of software \u2014 designed to run on underwater systems \u2014 that allows for extended functionality of DeepWater Exploration cameras. It provides out-of-the-box camera streaming and customization features, minimizing the development time typically required for subsea camera integration.
\n![\"DWE_OS\"](\"https://mintlify.s3-us-west-1.amazonaws.com/deepwaterexplorationinc/software/images/dwe_os_2/dwe-os-2-demo-page.png\"/)
For more information, please see our documentation site.
", "support": "https://dwe.ai/pages/contact", "requirements": null, "company": { "about": "", "name": "DeepWater Exploration", "email": "support@dwe.ai" }, "permissions": { "ExposedPorts": { "8000/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/sys/class/video4linux:/sys/class/video4linux", "/usr/blueos/userdata/dwe_os_2:/settings", "/dev:/dev" ], "PortBindings": { "8000/tcp": [ { "HostPort": "" } ] } } } }, "v0.5.0-arm64": { "identifier": "cd698ddd-2853-5ffb-937a-7b24c9d41e94", "type": "device-integration", "website": null, "images": [ { "expanded_size": 402919657, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:b42d9c9b3825a4449c8b8efed0a64a087c85ecf5a11895be7a6f437654070f3f" } ], "authors": [ { "name": "Brandon Stevens", "email": "support@dwe.ai" } ], "filter_tags": [ "cameras", "dwe-ai", "exporehd", "stellarhd", "deepwater-exploration" ], "extra_links": {}, "tag": "v0.5.0-arm64", "docs": null, "readme": "DWE_OS 2.0
\nDWE_OS is an optional piece of software \u2014 designed to run on underwater systems \u2014 that allows for extended functionality of DeepWater Exploration cameras. It provides out-of-the-box camera streaming and customization features, minimizing the development time typically required for subsea camera integration.
\n
For more information, please see our documentation site.
", "support": "https://dwe.ai/pages/contact", "requirements": null, "company": { "about": "", "name": "DeepWater Exploration", "email": "support@dwe.ai" }, "permissions": { "ExposedPorts": { "8000/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/sys/class/video4linux:/sys/class/video4linux", "/usr/blueos/userdata/dwe_os_2:/settings", "/dev:/dev" ], "PortBindings": { "8000/tcp": [ { "HostPort": "" } ] } } } }, "v0.4.3": { "identifier": "f357bdef-fcd1-5851-895b-fcb1ac63117b", "type": "device-integration", "website": null, "images": [ { "expanded_size": 370445121, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:3278b8a0abb470f2b69f400fa4269c635f49069a13a21f50fbdb90823a0313d6" } ], "authors": [ { "name": "Brandon Stevens", "email": "support@dwe.ai" } ], "filter_tags": [ "cameras", "dwe-ai", "exporehd", "stellarhd", "deepwater-exploration" ], "extra_links": {}, "tag": "v0.4.3", "docs": null, "readme": "DWE_OS 2.0
\nDWE_OS is an optional piece of software \u2014 designed to run on underwater systems \u2014 that allows for extended functionality of DeepWater Exploration cameras. It provides out-of-the-box camera streaming and customization features, minimizing the development time typically required for subsea camera integration.
\n
For more information, please see our documentation site.
", "support": "https://dwe.ai/pages/contact", "requirements": null, "company": { "about": "", "name": "DeepWater Exploration", "email": "support@dwe.ai" }, "permissions": { "ExposedPorts": { "8000/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/sys/class/video4linux:/sys/class/video4linux", "/usr/blueos/userdata/dwe_os_2:/settings", "/dev:/dev" ], "PortBindings": { "8000/tcp": [ { "HostPort": "" } ] } } } }, "v0.4.3-blueos": { "identifier": "27502449-4909-5055-ae73-923014149e95", "type": "device-integration", "website": null, "images": [ { "expanded_size": 376564891, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:31868a37aea7d6ebcac625644afaaa5c6dd67ea28575818b2d9658987093fc83" } ], "authors": [ { "name": "Brandon Stevens", "email": "support@dwe.ai" } ], "filter_tags": [ "cameras", "dwe-ai", "exporehd", "stellarhd", "deepwater-exploration" ], "extra_links": {}, "tag": "v0.4.3-blueos", "docs": null, "readme": "DWE_OS 2.0
\nDWE_OS is an optional piece of software \u2014 designed to run on underwater systems \u2014 that allows for extended functionality of DeepWater Exploration cameras. It provides out-of-the-box camera streaming and customization features, minimizing the development time typically required for subsea camera integration.
\n
For more information, please see our documentation site.
", "support": "https://dwe.ai/pages/contact", "requirements": null, "company": { "about": "", "name": "DeepWater Exploration", "email": "support@dwe.ai" }, "permissions": { "ExposedPorts": { "8000/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/sys/class/video4linux:/sys/class/video4linux", "/usr/blueos/userdata/dwe_os_2:/settings", "/dev:/dev" ], "PortBindings": { "8000/tcp": [ { "HostPort": "" } ] } } } }, "v0.4.2-blueos": { "identifier": "1fb63ce3-09f3-528b-8dea-a63a5e16313d", "type": "device-integration", "website": null, "images": [ { "expanded_size": 375587336, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:98597305c3257d6dc846ee363b20380a4bdea72fe2c122c827c6579fcca40db9" } ], "authors": [ { "name": "Brandon Stevens", "email": "support@dwe.ai" } ], "filter_tags": [ "cameras", "dwe-ai", "exporehd", "stellarhd", "deepwater-exploration" ], "extra_links": {}, "tag": "v0.4.2-blueos", "docs": null, "readme": "DWE_OS 2.0
\nDWE_OS is an optional piece of software \u2014 designed to run on underwater systems \u2014 that allows for extended functionality of DeepWater Exploration cameras. It provides out-of-the-box camera streaming and customization features, minimizing the development time typically required for subsea camera integration.
\n
For more information, please see our documentation site.
", "support": "https://dwe.ai/pages/contact", "requirements": null, "company": { "about": "", "name": "DeepWater Exploration", "email": "support@dwe.ai" }, "permissions": { "ExposedPorts": { "8000/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/sys/class/video4linux:/sys/class/video4linux", "/usr/blueos/userdata/dwe_os_2:/settings", "/dev:/dev" ], "PortBindings": { "8000/tcp": [ { "HostPort": "" } ] } } } }, "v0.4.1-beta-3.9": { "identifier": "8cc249c7-14ce-5852-8152-e8914c2eb486", "type": "device-integration", "website": null, "images": [ { "expanded_size": 378651240, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:b7e116dc2e25bef77c88bf8761fd8ec74a698e5f9b6554a78e80ec0482fc380f" } ], "authors": [ { "name": "Brandon Stevens", "email": "support@dwe.ai" } ], "filter_tags": [ "cameras", "dwe-ai", "exporehd", "stellarhd", "deepwater-exploration" ], "extra_links": {}, "tag": "v0.4.1-beta-3.9", "docs": null, "readme": "DWE_OS 2.0
\nDWE_OS is an optional piece of software \u2014 designed to run on underwater systems \u2014 that allows for extended functionality of DeepWater Exploration cameras. It provides out-of-the-box camera streaming and customization features, minimizing the development time typically required for subsea camera integration.
\n
For more information, please see our documentation site.
", "support": "https://dwe.ai/pages/contact", "requirements": null, "company": { "about": "", "name": "DeepWater Exploration", "email": "support@dwe.ai" }, "permissions": { "ExposedPorts": { "8000/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/sys/class/video4linux:/sys/class/video4linux", "/usr/blueos/userdata/dwe_os_2:/settings", "/dev:/dev" ], "PortBindings": { "8000/tcp": [ { "HostPort": "" } ] } } } } }, "repo_info": { "downloads": 9337, "last_updated": "2026-01-30T23:08:57.02872Z", "date_registered": "2024-10-28T21:23:12.958451Z" } }, { "identifier": "marinesitu.madrona", "name": "Madrona", "website": "https://gitlab.com/marinesitu-public/madrona/madrona", "docker": "marinesitu/madrona", "description": "Generic OAK-D camera management, configuration, and surveying software optimized for MarineSitu's underwater C3 camera line", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/marinesitu/madrona/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/marinesitu/company_logo.png", "versions": { "1.13.2": { "identifier": "3377d739-80b5-5041-b640-0c8ee8120a6f", "type": "device-integration", "website": "https://marinesitu.com", "images": [ { "expanded_size": 1353521957, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:87fd62a428df67d878b22421a38bbccc3c6639dd1f86c980cb00195df237cace" }, { "expanded_size": 1315657868, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:75396c20f7dec6d319640df51000907c1a3bbb9fe722f147ea56e1b2e27b5a8e" }, { "expanded_size": 1112706913, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:5fa72dca5bfbe5f462b543864f8aa7852e13e5e135012f0a438faea27d9a625a" } ], "authors": [ { "name": "Jack Mead", "email": "jack@marinesitu.com" } ], "filter_tags": [ "luxonis", "oak-d", "stereo", "depth", "camera", "data-collection" ], "extra_links": {}, "tag": "1.13.2", "docs": null, "readme": "Madrona
\n\n
\n
![\"pipeline](\"https://gitlab.com/marinesitu-public/madrona/madrona/badges/main/pipeline.svg\"/)
Camera management, configuration, and surveying software optimized for MarineSitu\u2019s underwater C3 camera line
\nMadrona is a web-based tool for managing MarineSitu's C3 cameras. It allows users to configure, control, and stream video from the cameras in a variety of ways. Designed to be used with the BlueOS Cockpit for BlueROV or as a standalone application.
\nFor more information on hardware specifications, see the MarineSitu Website.
\nFor usage, see the official documentation at: Madrona Documenation.
\nFor installation and developing, see the Installation Guide.
\nFor building, versioning, and CI/CD release details see the Versioning.
\nFor releases details on new features and changes, see the ChangeLog.
\nIf you would like to contribute to the project by coding, requesting features, or submitting bug reports, please see the Contributing Guide.
", "support": "contact@marinesitu.com", "requirements": null, "company": { "about": "Leaders in Ocean Intelligence", "name": "MarineSitu Inc.", "email": "contact@marinesitu.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev/bus/usb:/dev/bus/usb", "/usr/blueos/extensions/madrona:/data/madrona" ], "DeviceCgroupRules": [ "c 189:* rmw" ] } } }, "1.13.1": { "identifier": "13a485eb-bff8-57a3-8a85-eb85becbed8c", "type": "device-integration", "website": "https://marinesitu.com", "images": [ { "expanded_size": 1353521945, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:ae21ec4a87bcaea3319d1959dbf4cfe480d1f58a5fa31854f358e89973e9232c" }, { "expanded_size": 1315657864, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:f991e57219df4907128d63d9bd18bde202cb1e2c30a7a97e54023c6a02e8db90" } ], "authors": [ { "name": "Jack Mead", "email": "jack@marinesitu.com" } ], "filter_tags": [ "luxonis", "oak-d", "stereo", "depth", "camera", "data-collection" ], "extra_links": {}, "tag": "1.13.1", "docs": null, "readme": "Madrona
\n\n
\n
Camera management, configuration, and surveying software optimized for MarineSitu\u2019s underwater C3 camera line
\nMadrona is a web-based tool for managing MarineSitu's C3 cameras. It allows users to configure, control, and stream video from the cameras in a variety of ways. Designed to be used with the BlueOS Cockpit for BlueROV or as a standalone application.
\nFor more information on hardware specifications, see the MarineSitu Website.
\nFor usage, see the official documentation at: Madrona Documenation.
\nFor installation and developing, see the Installation Guide.
\nFor building, versioning, and CI/CD release details see the Versioning.
\nFor releases details on new features and changes, see the ChangeLog.
\nIf you would like to contribute to the project by coding, requesting features, or submitting bug reports, please see the Contributing Guide.
", "support": "contact@marinesitu.com", "requirements": null, "company": { "about": "Leaders in Ocean Intelligence", "name": "MarineSitu Inc.", "email": "contact@marinesitu.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev/bus/usb:/dev/bus/usb", "/usr/blueos/extensions/madrona:/data/madrona" ], "DeviceCgroupRules": [ "c 189:* rmw" ] } } }, "1.13.0": { "identifier": "80b930d8-75a7-5c9b-9b32-cd0f48174128", "type": "device-integration", "website": "https://marinesitu.com", "images": [ { "expanded_size": 1315657766, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:b07eed5af17f57d5f4fecf1bc1e8e8eef6804cfc8320f3d73fe3614d8f0234f6" } ], "authors": [ { "name": "Jack Mead", "email": "jack@marinesitu.com" } ], "filter_tags": [ "luxonis", "oak-d", "stereo", "depth", "camera", "data-collection" ], "extra_links": {}, "tag": "1.13.0", "docs": null, "readme": "Madrona
\n\n
\n
Camera management, configuration, and surveying software optimized for MarineSitu\u2019s underwater C3 camera line
\nMadrona is a web-based tool for managing MarineSitu's C3 cameras. It allows users to configure, control, and stream video from the cameras in a variety of ways. Designed to be used with the BlueOS Cockpit for BlueROV or as a standalone application.
\nFor more information on hardware specifications, see the MarineSitu Website.
\nFor usage, see the official documentation at: Madrona Documenation.
\nFor installation and developing, see the Installation Guide.
\nFor building, versioning, and CI/CD release details see the Versioning.
\nFor releases details on new features and changes, see the ChangeLog.
\nIf you would like to contribute to the project by coding, requesting features, or submitting bug reports, please see the Contributing Guide.
", "support": "contact@marinesitu.com", "requirements": null, "company": { "about": "Leaders in Ocean Intelligence", "name": "MarineSitu Inc.", "email": "contact@marinesitu.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev/bus/usb:/dev/bus/usb", "/usr/blueos/extensions/madrona:/data/madrona" ], "DeviceCgroupRules": [ "c 189:* rmw" ] } } }, "1.12.2": { "identifier": "28ae9281-4ea7-5dbe-ab87-1d5a6a67e6af", "type": "device-integration", "website": "https://marinesitu.com", "images": [ { "expanded_size": 1315657318, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:63d062ccd360ce56379a94ee20f9afb7ddbc495a6de68cff2b8108530b809cc0" } ], "authors": [ { "name": "Jack Mead", "email": "jack@marinesitu.com" } ], "filter_tags": [ "luxonis", "oak-d", "stereo", "depth", "camera", "data-collection" ], "extra_links": {}, "tag": "1.12.2", "docs": null, "readme": "Madrona
\n\n
\n
Camera management, configuration, and surveying software optimized for MarineSitu\u2019s underwater C3 camera line
\nMadrona is a web-based tool for managing MarineSitu's C3 cameras. It allows users to configure, control, and stream video from the cameras in a variety of ways. Designed to be used with the BlueOS Cockpit for BlueROV or as a standalone application.
\nFor more information on hardware specifications, see the MarineSitu Website.
\nFor usage, see the official documentation at: Madrona Documenation.
\nFor installation and developing, see the Installation Guide.
\nFor building, versioning, and CI/CD release details see the Versioning.
\nFor releases details on new features and changes, see the ChangeLog.
\nIf you would like to contribute to the project by coding, requesting features, or submitting bug reports, please see the Contributing Guide.
", "support": "contact@marinesitu.com", "requirements": null, "company": { "about": "Leaders in Ocean Intelligence", "name": "MarineSitu Inc.", "email": "contact@marinesitu.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev/bus/usb:/dev/bus/usb", "/usr/blueos/extensions/madrona:/data/madrona" ], "DeviceCgroupRules": [ "c 189:* rmw" ] } } }, "1.3.1": { "identifier": "7834d378-4876-5c97-8ab4-c19e96b567cb", "type": "device-integration", "website": "https://marinesitu.com", "images": [ { "expanded_size": 1353521945, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:ae21ec4a87bcaea3319d1959dbf4cfe480d1f58a5fa31854f358e89973e9232c" }, { "expanded_size": 1315657864, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:f991e57219df4907128d63d9bd18bde202cb1e2c30a7a97e54023c6a02e8db90" } ], "authors": [ { "name": "Jack Mead", "email": "jack@marinesitu.com" } ], "filter_tags": [ "luxonis", "oak-d", "stereo", "depth", "camera", "data-collection" ], "extra_links": {}, "tag": "1.3.1", "docs": null, "readme": "Madrona
\n\n
\n
Camera management, configuration, and surveying software optimized for MarineSitu\u2019s underwater C3 camera line
\nMadrona is a web-based tool for managing MarineSitu's C3 cameras. It allows users to configure, control, and stream video from the cameras in a variety of ways. Designed to be used with the BlueOS Cockpit for BlueROV or as a standalone application.
\nFor more information on hardware specifications, see the MarineSitu Website.
\nFor usage, see the official documentation at: Madrona Documenation.
\nFor installation and developing, see the Installation Guide.
\nFor building, versioning, and CI/CD release details see the Versioning.
\nFor releases details on new features and changes, see the ChangeLog.
\nIf you would like to contribute to the project by coding, requesting features, or submitting bug reports, please see the Contributing Guide.
", "support": "contact@marinesitu.com", "requirements": null, "company": { "about": "Leaders in Ocean Intelligence", "name": "MarineSitu Inc.", "email": "contact@marinesitu.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev/bus/usb:/dev/bus/usb", "/usr/blueos/extensions/madrona:/data/madrona" ], "DeviceCgroupRules": [ "c 189:* rmw" ] } } } }, "repo_info": { "downloads": 8718, "last_updated": "2026-02-05T20:04:31.590433Z", "date_registered": "2025-03-27T21:00:19.768813Z" } }, { "identifier": "bluerobotics.jupyter", "name": "Jupyter", "website": "https://github.com/BlueOS-Community/blueos-jupyter", "docker": "patrickelectric/blueos-jupyter", "description": "Code in Python directly in BlueOS", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/jupyter/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/company_logo.png", "versions": { "0.2.0": { "identifier": "b1da3c8a-0fc4-5070-bb26-9d15bed8056c", "type": "other", "website": null, "images": [ { "expanded_size": 1178493617, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:f578a510f7a7dfaa8acf4cb331b9db23640e57ad6a1e4df15fc8da4db7d54d25" }, { "expanded_size": 1213335519, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:e3fad50b8a2b844e5e9727b2a5411e2b52e0f95b003ad147ccd22e8e591f8160" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" }, { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "python", "ide", "development" ], "extra_links": {}, "tag": "0.2.0", "docs": null, "readme": "blueos-jupyter
\nExtension to start coding with python examples and create projects.
\nTo install your own libraries, use: pip install --user.
Home directory (/root/) will be persistent besides pip local holder for user libraries.
Libraries installed:\n- bluerobotics-ping\n- bluerobotics-navigator\n- plotly\n- pymavlink
", "support": null, "requirements": null, "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/extensions/jupyter/root:/root:rw", "/dev:/dev:rw" ], "NetworkMode": "host" } } }, "0.1.0": { "identifier": "0fe22234-421f-5549-86e1-44515ecc0c37", "type": "other", "website": null, "images": [ { "expanded_size": 946708030, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:7fbecadd64e1b484f67a6cafda92c3f4b9630e277d83a4288196ebbf01af336f" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" }, { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "python", "ide", "development" ], "extra_links": {}, "tag": "0.1.0", "docs": null, "readme": "blueos-jupyter
\nExtension to start coding with python examples and create projects.
\nTo install your own libraries, use: pip install --user.
Home directory (/root/) will be persistent besides pip local holder for user libraries.
Libraries installed:\n- bluerobotics-ping\n- bluerobotics-navigator\n- plotly\n- pymavlink
", "support": null, "requirements": null, "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/extensions/jupyter/root:/root:rw", "/dev:/dev:rw" ], "NetworkMode": "host" } } }, "0.0.0": { "identifier": "513dcee7-8d8e-5e4c-bcb6-71b7e15c44fd", "type": "other", "website": null, "images": [ { "expanded_size": 471140182, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:80fbf5feb15c6e9f08544727addaabdd28968cec1ea44ef70553026ed49b09d1" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" }, { "name": "Raul Trombin", "email": "raulvtormbin@gmail.com" } ], "filter_tags": [ "python", "ide", "development" ], "extra_links": {}, "tag": "0.0.0", "docs": null, "readme": "blueos-jupyter
\nExtension to start coding with python examples and create projects.
\nTo install your own libraries, use: pip install --user.
Home directory (/root/) will be persistent besides pip local holder for user libraries.
Libraries installed:\n- bluerobotics-ping\n- bluerobotics-navigator\n- plotly\n- pymavlink
", "support": null, "requirements": null, "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata/jupyter/root:/root:rw", "/dev:/dev:rw" ], "NetworkMode": "host" } } } }, "repo_info": { "downloads": 10243, "last_updated": "2024-11-02T19:51:27.122486Z", "date_registered": "2023-09-20T20:30:01.66808Z" } }, { "identifier": "bluerobotics.blueos-documentation", "name": "BR Documentation", "website": "https://github.com/bluerobotics/BlueRobotics-docs-Extension", "docker": "bluerobotics/blueos-docs", "description": "Blue Robotics software documentation", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/blueos-documentation/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/company_logo.png", "versions": { "2025.2.8": { "identifier": "ec8b692a-9478-5cd2-b23e-bbd42a63ba10", "type": "other", "website": null, "images": [ { "expanded_size": 146399379, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:28fe2371a69dea5b5ab5908a76fa0741065d072429b9822b7f500edd36a8b825" }, { "expanded_size": 147154260, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:a3b8029009e5bd950d679592a365a19398014f253cd0ce1d5e820a066a14314c" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" }, { "name": "ES-Alexander", "email": "sandman.esalexander@gmail.com" } ], "filter_tags": [ "development", "documentation" ], "extra_links": {}, "tag": "2025.2.8", "docs": null, "readme": "A local, offline copy of the latest Blue Robotics software documentation.
\nIncludes documentation for BlueOS as well as Cockpit.
", "support": null, "requirements": null, "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } } }, "repo_info": { "downloads": 1092, "last_updated": "2025-02-07T19:07:24.353007Z", "date_registered": "2025-02-06T15:30:31.14782Z" } }, { "identifier": "bluerobotics.node-red", "name": "Node-RED", "website": "https://github.com/BlueOS-Community/blueos-node-red", "docker": "patrickelectric/blueos-node-red", "description": "Low-code development tool for custom functionality", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/node-red/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/company_logo.png", "versions": { "1.1.0": { "identifier": "4e50156a-1afb-592e-bf18-c159d7c126a0", "type": "other", "website": null, "images": [ { "expanded_size": 168829981, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:7fd15626dafae013f3d3bfd8dde4a11003bbd9c1c1c1d9e63edaa765fba77542" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "node-red" ], "extra_links": {}, "tag": "1.1.0", "docs": null, "readme": "BlueOS node-red
\nNode-RED is a programming tool for wiring together hardware devices, APIs and online services in new and interesting ways.
\nIt provides a browser-based editor that makes it easy to wire together flows using the wide range of nodes in the palette that can be deployed to its runtime in a single-click.
", "support": null, "requirements": null, "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/extensions/node-red:/data:rw", "/etc/hostname:/etc/hostname:ro", "/dev:/dev:rw", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.0.3": { "identifier": "f56aceb6-80df-59c4-8b04-ec4fb55ce680", "type": "other", "website": null, "images": [ { "expanded_size": 161203610, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:40af90b41e49214ab3cd2551871caae204e2d2bb484cf647c4b8b5db15936e1c" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "node-red" ], "extra_links": {}, "tag": "1.0.3", "docs": null, "readme": "BlueOS node-red
\nNode-RED is a programming tool for wiring together hardware devices, APIs and online services in new and interesting ways.
\nIt provides a browser-based editor that makes it easy to wire together flows using the wide range of nodes in the palette that can be deployed to its runtime in a single-click.
", "support": null, "requirements": null, "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/extensions/node-red:/data:rw", "/etc/hostname:/etc/hostname:ro", "/dev:/dev:rw", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.0.2": { "identifier": "0b938a2c-503c-532d-8e70-842f4f0b4321", "type": "other", "website": null, "images": [ { "expanded_size": 157814612, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:20ce89d066804fc5c0207b71e7de85488abd1caccb011c21ee5a66d4df7f3130" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "node-red" ], "extra_links": {}, "tag": "1.0.2", "docs": null, "readme": "BlueOS node-red
\nNode-RED is a programming tool for wiring together hardware devices, APIs and online services in new and interesting ways.
\nIt provides a browser-based editor that makes it easy to wire together flows using the wide range of nodes in the palette that can be deployed to its runtime in a single-click.
", "support": null, "requirements": null, "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata/node-red:/data:rw", "/etc/hostname:/etc/hostname:ro", "/dev:/dev:rw", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.0.1": { "identifier": "4fdb3c47-ee61-5322-a7ca-1e85416dbadc", "type": "other", "website": null, "images": [ { "expanded_size": 161234072, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:7e898a24b188429bad6bb6d1229ae906a1447b732afbc69fe29b22a5b839af89" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "node-red" ], "extra_links": {}, "tag": "1.0.1", "docs": null, "readme": "BlueOS node-red
\nNode-RED is a programming tool for wiring together hardware devices, APIs and online services in new and interesting ways.
\nIt provides a browser-based editor that makes it easy to wire together flows using the wide range of nodes in the palette that can be deployed to its runtime in a single-click.
", "support": null, "requirements": null, "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata/node-red:/data:rw", "/etc/hostname:/etc/hostname:ro", "/dev:/dev:rw", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.0.0": { "identifier": "10ae5964-f59f-53a9-8828-664dc3406aab", "type": "other", "website": null, "images": [ { "expanded_size": 161234072, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:7e898a24b188429bad6bb6d1229ae906a1447b732afbc69fe29b22a5b839af89" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "node-red" ], "extra_links": {}, "tag": "1.0.0", "docs": null, "readme": "BlueOS node-red
\nNode-RED is a programming tool for wiring together hardware devices, APIs and online services in new and interesting ways.
\nIt provides a browser-based editor that makes it easy to wire together flows using the wide range of nodes in the palette that can be deployed to its runtime in a single-click.
", "support": null, "requirements": null, "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata/node-red:/data:rw", "/etc/hostname:/etc/hostname:ro", "/dev:/dev:rw", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } } }, "repo_info": { "downloads": 20173, "last_updated": "2024-07-29T21:22:46.380269Z", "date_registered": "2023-08-29T20:22:57.798237Z" } }, { "identifier": "bluerobotics.blueos-doris", "name": "DORIS", "website": "https://github.com/bluerobotics/blueos-doris-extension", "docker": "bluerobotics/blueos-doris", "description": "DORIS - Deep Ocean Research and Imaging System", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/blueos-doris/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/company_logo.png", "versions": { "0.0.20": { "identifier": "38f47d7d-7370-5a9c-8fb7-41e544dd8d2c", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 157303617, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:4c30c61aede1c08a879e0b70befbf1d385cd8e605e092732afdca5be26e6040c" }, { "expanded_size": 186640146, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:0205aea275130324f6ecaed9a0cd2b059daacdd60d569a7d330ef872720a6455" }, { "expanded_size": 194249226, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:7adbc2181088e05dd18c8fb3928b7c9e7105382b98cbb888e7843162445c89f6" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.20", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/dev:/dev:rw", "/root/.config/blueos/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris/configurations:/tmp/storage/configurations", "/usr/blueos/extensions/doris/notifications:/tmp/storage/notifications", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.19": { "identifier": "f8105290-94a4-5c17-9519-251229072b63", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 157303836, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:62ee9ebfa213954b191aa6235626a683fb7ad0b0958738e23bde7a4ec19cc2a0" }, { "expanded_size": 186640439, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:f5dfc99eca5b811a65c37f84187a651b3489efd039d427fb1c5395d32d3db7b4" }, { "expanded_size": 194249214, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:53d2f8921d481ab05e5a7375bc337e38609f3e707b98ecd032bc9769873732f5" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.19", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/dev:/dev:rw", "/root/.config/blueos/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.18": { "identifier": "92551a83-aad8-5ea4-ac9e-d1a8be208b6c", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 157288336, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:56666432b9b7d18d4875422559cca3684effa9a645b048f13c76a172c9188aad" }, { "expanded_size": 186632885, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:5ac9c84c5f1ea7f308376e70bd703a7e244c0a0dabcf0eca8db34e787caaee5b" }, { "expanded_size": 194243910, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:2d730b91472a8e65c7b57e56edbded88b288c41a689089105d89fd6b1b3745ad" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.18", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/dev:/dev:rw", "/root/.config/blueos/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.17": { "identifier": "656dcb80-d010-5cbc-891e-ddb2f8063d9a", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 157288573, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:184aef2835f10501f4cfb8ee12d5b4c897e1d4ede46d498be53eb3c87f1393bc" }, { "expanded_size": 186633176, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:8d700eafef677a1ac35bd06cc88b97bd4060e89b3295a83fb64ae57307ac0f8e" }, { "expanded_size": 194244399, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:dbb7f22142e03c715059ab8864d3e387edb16ba0b07d8fe995e180b0bb3e6a53" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.17", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/dev:/dev:rw", "/root/.config/blueos/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.16": { "identifier": "e80aeae8-75d8-5c81-9bb8-fa785d03f3f9", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 157289196, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:da09c9af9e6515aec89b59b5932c619fc27faf536dcf53c093b850d04c2dfe07" }, { "expanded_size": 186632974, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:34590a00a98dc7fdbbc60c86644991398d5827f181ee7cee76cae4cb78fa7e49" }, { "expanded_size": 194244004, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:b5a317126c4d85c1fad7b1af7b3f6653fe622afafa139cc2c258b60f8fcf6b7a" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.16", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/dev:/dev:rw", "/root/.config/blueos/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.15": { "identifier": "37ad8e2c-4d43-54c7-aaf4-43ab41dd47ae", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 157288714, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:ea92f247e8b80f90e7fcbfadf7161b8b9a4fb6b0da9fc707553d6778d5a8a09d" }, { "expanded_size": 186633381, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:01d3b10c5c14449a18251c8725820aa2d4b2eee593ea963624c7ab88f1dabb37" }, { "expanded_size": 194243993, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:cc057649e3d7df10c8e0833af8a2a660fb088aac3dd8a326845317202d8e2345" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.15", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/dev:/dev:rw", "/root/.config/blueos/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.14": { "identifier": "af96bb22-41e8-5dbf-a88b-da0556d5a7f3", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 157288326, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:363f0f64dfe15db2df8970ae0e20f07640f26dd0a75a021dfc284b1818f53589" }, { "expanded_size": 186633167, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:88edc83089d90ddc12a205961dc8cac580b6b58c63a44392f6ee9346bb1ddb04" }, { "expanded_size": 194243807, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:437338e63f8e39fde0c64e0c28ff1636bbe074fffefe2946f2d20350e1accbd1" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.14", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/dev:/dev:rw", "/root/.config/blueos/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.13": { "identifier": "c71bd649-fa4a-5317-88df-c6bc36b469ad", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 157288228, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:19df1d2529a7c8335f30af5931e0abff3528771e74a4690d5f3a995d02db285e" }, { "expanded_size": 186633364, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:36e0c0d9cf0df6c65910575e624a482141d7270af54974792e6a1ad9aaddcfe6" }, { "expanded_size": 194243568, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:cd1e99bc12da730c216f542efe9560c78971e34227e273def13d4ea583e55e70" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.13", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config/blueos/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.12": { "identifier": "64dee75d-23e4-586b-9e72-7578e24bd61e", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 157054481, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:b85427c497c168220bafa99a1e383d9f8d71c32cd08e5705a685734ea730a9f9" }, { "expanded_size": 186399179, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:41a9b7e83fc912713c89931054787a39017695cf47225bef93ce1f63f12b46f1" }, { "expanded_size": 194011135, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:fc8e64f9eab26c25598a5230c6c9a252e133249e57194cb41a696a07501bc4f7" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.12", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config/blueos/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.11": { "identifier": "d371452f-0b5d-5565-98ce-c185b2826d1f", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 157049191, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:75bf0b26c738a687ea152a90c2e05a93a3f60cb9f9c00d779321e187eb70ea9f" }, { "expanded_size": 186395173, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:3e8c6faed94f8a0fbac4bc2ef625684cd53d4c662fce5483522581e4949c40e1" }, { "expanded_size": 194005860, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:0ef797a3e0b0c03a5858ad531930a6d17d192f0cc2a15a8daab4bb84d3f64ae4" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.11", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.10": { "identifier": "07aa4f24-239e-5385-901d-0f7e35dfe614", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 156653052, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:9ee91f92c8bc343f38aeea6de9621b079dd924774b4394de4a7775de92afac76" }, { "expanded_size": 185999438, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:e44a78068eb5943d64e4990ed4fed62136c2015a66e55e7f7eb2742b21ef19d6" }, { "expanded_size": 193609864, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:e03de996abca483ef5d78c5d4ff8b395da47c603322dfbf347995674bc3c275d" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.10", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.9": { "identifier": "bd867b5e-61c9-533b-bea4-89a4d90db044", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 156736721, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:63205850d699d89517f65a39ee8939674b956c36383ce269f61d7b603b4587d2" }, { "expanded_size": 186084094, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:531426e5c48b23d1fbd45acdce226342729dd9117c7243a1ea0a7433c6268856" }, { "expanded_size": 193694740, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:d3bd669bc3179ca84942e3ed7076b45db81fa0f2744a9adcd67e38776e07eb20" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.9", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.8": { "identifier": "ade93fe1-afdd-5d9f-8a7a-979aaafb3ede", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 155521230, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:56e924717db1834429b96b2686ce24f04b6fcf8dedf2c4a20a12d0ad42c00c12" }, { "expanded_size": 184847196, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:009859182fff3d50868a7b8ac4d33d2a8bc2afccc9436f03cce397cf0073c808" }, { "expanded_size": 192470798, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:d851c8a17f905e4bde3ca7415098d66add3058ed935f126aa811caf6d4db473d" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.8", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.7": { "identifier": "7ef2927b-8cd4-5c4b-ac3c-d34fea1130d3", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 155519986, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:94512a7deed8ab284351c4b63e1efac6ee2364ee380fd861c1ec91ece785829c" }, { "expanded_size": 184845837, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:2fd0508d16ada644f1c303979cf8da49cfb4b58bc4de4b0670e986552f9bf4a8" }, { "expanded_size": 192469449, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:7466d2589f9193533c0c5c3e8e7931738ef84cc40e1b5360403b522bfbec780e" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.7", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.6": { "identifier": "007456a8-0ac8-5396-9643-62a7fc7c4552", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 155517357, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:33b9b5717dc1cc7b12e41eaf3ebbdc4a8e4b7ef605f9bb3f64e9d9c1831de6c2" }, { "expanded_size": 184845055, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:a0c1e70e727a245683567c3a11f2c5d88551d7804e89ad97935d2a34d49cb0df" }, { "expanded_size": 192467443, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:30171d63bc94affc10359fb8ba37ef97702d113a32cd7f25c2287aa346c31a40" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.6", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.5": { "identifier": "563ac639-9665-5af1-88ba-c3865c789dd5", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 155518092, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:7dd1d57a7ea32ee6ff3ed5fad8ff85d320063c2bf9977860e8cad0fe9fe54ebe" }, { "expanded_size": 184844175, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:5fd08bcb7ec886c7447da0ebd8eac403f2c4820a6eeabde74e4595c4e9c63f91" }, { "expanded_size": 192467444, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:dcf2849064d6db3fbcbef95cfcea358b511acb6982198d02e8bc7e2b362eb1b5" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.5", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config/ardupilot-manager/firmware:/tmp/storage/firmware", "/usr/blueos/extensions/doris:/tmp/storage/internal", "/usr/blueos/userdata/recorder:/tmp/storage/recorder" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.4": { "identifier": "3f5990af-c2fe-5b78-ad7a-f2a83bb50fc3", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 155517444, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:0b0f921c426acfe7f6cd67110fc2c0501a7f049860fdb3f5c102f67a78700925" }, { "expanded_size": 184844349, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:c473b781c23075ee53e8f162406d84c31f78852b8a67d525b1e30ed6d6f8fd4a" }, { "expanded_size": 192467440, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:bbb580845c7c391c82fcc0e23b11c19e0a4ecd5219a07f91973e8700b08d039e" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.4", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/usr/blueos/extensions/doris:/tmp/storage" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.3": { "identifier": "c2c27abf-5ecb-591b-9772-def85c2c737e", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 155516823, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:20fbbe1856eaaa1a5b1215b18566d3ab9fae76ebd14b57a03ad10547d78191fb" }, { "expanded_size": 184844764, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:039f29ee9d2b7d94a2a73682231cf4f962ed185d55868fff4aa044255f3cdd8d" }, { "expanded_size": 192466414, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:33f2665c76df641d2cd0ac864207fd3c054cdb67159f51efb74daece06f61e68" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.3", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/usr/blueos/extensions/doris:/tmp/storage" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.2": { "identifier": "0c086e55-7c02-5a6c-93ca-5004bfd7b89e", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 155087536, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:26b8220229b30511cb9bfe657411cf9f392119f6af7575f66c2ab60f33cac56b" }, { "expanded_size": 184411620, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:fddd34f608f00567ca1e032681f51563537a3a53a81ee6f199273733a6f893dc" }, { "expanded_size": 192035134, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:7012793838c798770eab56fe5661ca54dd4ee7a66cd986421a5b5910e921b631" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.2", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/usr/blueos/extensions/doris:/data" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } }, "0.0.1": { "identifier": "84a705c2-8a9e-58f2-b570-9a9c16976c89", "type": "device-integration", "website": "https://bluerobotics.com", "images": [ { "expanded_size": 154635285, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:4a516b6c55dfce7d419c8177bad6db119cc2b087e125c0ec0aed296b6dc5e667" }, { "expanded_size": 183971519, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:6cfb2f62bd6f4787be2f51ffe794f1884a0633c2bad9fc33f801b569bdf4a118" }, { "expanded_size": 191590036, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:552cad04d1a262520acfa4b40c9035c15e97b6d6a0c83178a8d323935abe637d" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/bluerobotics/blueos-doris-extension" }, "tag": "0.0.1", "docs": null, "readme": "DORIS - Deep Ocean Research and Imaging System
\nA BlueOS extension for deep ocean research and imaging operations.
\nFeatures
\n- \n
- Real-time System Status: Battery, storage, and CPU monitoring \n
- Location Tracking: GPS position with satellite count \n
- Network Management: WiFi scanning and connection via BlueOS \n
- Mission Programming: Configure and manage research missions \n
- Sensor Configuration: Monitor and configure connected modules \n
- Media Management: Access captured images and video \n
- BlueOS Integration: Automatic service registration and discovery \n
Architecture
\nblueos-doris-extension/\n\u251c\u2500\u2500 frontend/ # Vue 3 + TypeScript web interface\n\u251c\u2500\u2500 backend/ # Python + Robyn API server\n\u2502 \u2514\u2500\u2500 src/doris/\n\u2502 \u251c\u2500\u2500 routes/ # API endpoints\n\u2502 \u251c\u2500\u2500 services/ # BlueOS service integrations\n\u2502 \u2514\u2500\u2500 models/ # Pydantic data models\n\u251c\u2500\u2500 .github/workflows/ # CI/CD deployment\n\u251c\u2500\u2500 Dockerfile # BlueOS extension container\n\u2514\u2500\u2500 docker-compose.yml # Local development setup
Quick Start
\nUsing Docker (Recommended)
\n```bash
\nBuild the image
\ndocker build -t doris:latest .
\nRun locally
\ndocker run -p 8095:8095 --add-host=host.docker.internal:host-gateway doris:latest\n```
\nThen open http://localhost:8095
\nUsing Docker Compose
\n```bash
\nEdit docker-compose.yml to set your BlueOS IP if needed
\ndocker-compose up --build\n```
\nDevelopment
\nPrerequisites
\n- \n
- Node.js 20+ with Yarn \n
- Python 3.11+ \n
- Docker (for container builds) \n
Local Development
\n- \n
- Start the frontend dev server: \n
bash\ncd frontend\nyarn install\nyarn dev
- \n
- Start the backend: \n
bash\ncd backend\nuv sync\nuv run python -m doris.main
- \n
- Configure BlueOS connection: \n
Set the environment variable to point to your BlueOS instance:
\nbash\nexport DORIS_BLUEOS_ADDRESS=http://192.168.2.2
Building for Production
\n```bash
\nBuild frontend
\ncd frontend && yarn build
\nRun backend (serves frontend)
\ncd backend && python -m doris.main\n```
\nDocker
\nBuild Optimization
\nThe Dockerfile is optimized for layer caching. Only changes to pyproject.toml will trigger a full rebuild (including uvloop compilation which takes ~10 minutes). Source code changes use cached dependencies for fast rebuilds (~30 seconds).
Environment Variables
\n| Variable | Default | Description |\n|----------|---------|-------------|\n| DORIS_BLUEOS_ADDRESS | http://host.docker.internal | BlueOS API base URL |\n| DORIS_PORT | 8095 | Backend server port |\n| DORIS_HOST | 0.0.0.0 | Backend bind address |
BlueOS Extension
\nWhen installed as a BlueOS extension, DORIS automatically connects to BlueOS services via host.docker.internal.
Service Registration
\nDORIS implements the /register_service endpoint for BlueOS Helper discovery. This allows BlueOS to:
- \n
- Display DORIS in the extensions menu \n
- Set up automatic nginx routing \n
- Show service metadata (icon, description, version) \n
Installation
\nFrom Docker Hub:\n<username>/blueos-doris:latest
From GitHub Container Registry:\nghcr.io/<owner>/blueos-doris:latest
- \n
- In BlueOS, go to Extensions \u2192 Install from URL \n
- Enter one of the Docker image URLs above \n
- DORIS will appear in the extensions menu \n
BlueOS APIs Used
\n| Service | Port | Purpose |\n|---------|------|---------|\n| WiFi Manager | 9000 | Network scanning and connection |\n| MAVLink2Rest | 6040 | GPS, battery, and vehicle data |\n| Linux2Rest | 6030 | System information and storage |\n| Ping Service | 9110 | Sonar sensor data |\n| Camera Manager | 6020 | Camera control |\n| Bag of Holding | 9101 | Persistent storage |
\nAPI Documentation
\nWhen running, API documentation is available at:
\n- \n
- OpenAPI (Swagger): http://localhost:8095/docs \n
Key Endpoints
\n| Method | Endpoint | Description |\n|--------|----------|-------------|\n| GET | /register_service | BlueOS service registration |\n| GET | /api/v1/health | Health check |\n| GET | /api/v1/system/status | System status (battery, storage, location) |\n| GET | /api/v1/network | Network information |\n| GET | /api/v1/sensors/modules | Connected modules |\n| GET | /api/v1/missions | List missions |\n| POST | /api/v1/missions | Create mission |\n| GET | /api/v1/media/files | List media files |
Deployment
\nGitHub Actions
\nThe repository includes automated deployment to both Docker Hub and GitHub Container Registry:
\n```yaml
\n.github/workflows/deploy.yml
\nTriggers on push, pull request, and manual dispatch
\n```
\nRequired Secrets:\n- DOCKER_USERNAME - Docker Hub username\n- DOCKER_PASSWORD - Docker Hub password/token
GHCR uses the built-in GITHUB_TOKEN (no additional secrets needed).
Manual Deployment
\n```bash
\nBuild and tag
\ndocker build -t yourusername/blueos-doris:latest .
\nPush to Docker Hub
\ndocker push yourusername/blueos-doris:latest
\nPush to GHCR
\ndocker tag yourusername/blueos-doris:latest ghcr.io/yourusername/blueos-doris:latest\ndocker push ghcr.io/yourusername/blueos-doris:latest\n```
", "support": null, "requirements": "core >= 1.1", "company": { "about": "Deep Ocean Research and Imaging System", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8095/tcp": {} }, "HostConfig": { "Binds": [ "/usr/blueos/extensions/doris:/data" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8095/tcp": [ { "HostPort": "" } ] } } } } }, "repo_info": { "downloads": 2997, "last_updated": "2026-04-01T05:07:24.878605Z", "date_registered": "2026-02-12T13:43:54.707847Z" } }, { "identifier": "bluerobotics.power-switch-calibration", "name": "PowerSwitch Calibration", "website": "https://github.com/rjehangir/BlueOS-PS-Calibration/", "docker": "rjehangir/blueos-ps-calibration", "description": "Calibrate offset on BlueBoat for improved measurements", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/power-switch-calibration/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/company_logo.png", "versions": { "v1.0.0": { "identifier": "bcc4553d-e923-5310-93d0-4a775fe22322", "type": "device-integration", "website": null, "images": [ { "expanded_size": 7915983, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:e542fdb888f196961b5cb710cbada54be76cfff90b16eb8e73a434f34abf672f" } ], "authors": [ { "name": "Rustom Jehangir", "email": "rusty@bluerobotics.com" } ], "filter_tags": [], "extra_links": {}, "tag": "v1.0.0", "docs": null, "readme": "BlueOS Power Switch Calibration Extension
\nThis extension provides a simple routine to calibrate the offset of the \"Power Switch\" used in the BlueBoat to provide a more accurate current and power measurement.
\nBuild
\nExecute the following command to build your extension:
\nshell\n docker buildx build --platform linux/arm/v7 . -t my_docker_user/blueos-ps-calibration:latest --output type=registry
BlueOS Code Server
\nBlueOS extension for OpenVSCode Server.
\nOpenVSCode server is a project where it provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. It's based on the very same architecture used by Gitpod or GitHub Codespaces at scale.
", "support": null, "requirements": null, "company": null, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata/openvscode/.cache:/home/workspace/.cache:rw", "/usr/blueos/userdata/openvscode/.local:/home/workspace/.local:rw", "/usr/blueos/userdata:/userdata:rw", "/usr/blueos/openvscode:/openvscode:rw", "/var/run/docker.sock:/var/run/docker.sock:rw", "/usr/bin/docker:/usr/bin/docker:ro", "/etc/hostname:/etc/hostname:ro", "/dev:/dev:rw", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.1.1": { "identifier": "9ea3a4bf-5af7-5628-bf18-a0112499a59d", "type": "other", "website": null, "images": [ { "expanded_size": 690118664, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:36249d2e485389d1a2cc2470160a2452236bba9684a1050f9a1a83bda032579e" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "vscode", "python", "rust" ], "extra_links": {}, "tag": "1.1.1", "docs": null, "readme": "BlueOS Code Server
\nBlueOS extension for OpenVSCode Server.
\nOpenVSCode server is a project where it provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. It's based on the very same architecture used by Gitpod or GitHub Codespaces at scale.
", "support": null, "requirements": null, "company": null, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata:/home/workspace/userdata:rw", "/usr/blueos/openvscode:/openvscode:rw", "/var/run/docker.sock:/var/run/docker.sock:rw", "/usr/bin/docker:/usr/bin/docker:ro", "/etc/hostname:/etc/hostname:ro", "/dev:/dev:rw", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.1.0": { "identifier": "f1e0dcf6-8ee1-5746-bd9b-5a8189bf4716", "type": "other", "website": null, "images": [ { "expanded_size": 800907473, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:c4bfff1256818710af76d7b9ca2cfff8d98f2edcacf745c2b460a5166d822ece" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "vscode", "python", "rust" ], "extra_links": {}, "tag": "1.1.0", "docs": null, "readme": "BlueOS Code Server
\nBlueOS extension for OpenVSCode Server.
\nOpenVSCode server is a project where it provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. It's based on the very same architecture used by Gitpod or GitHub Codespaces at scale.
", "support": null, "requirements": null, "company": null, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata:/home/workspace/userdata:rw", "/usr/blueos/openvscode:/openvscode:rw", "/var/run/docker.sock:/var/run/docker.sock:rw", "/usr/bin/docker:/usr/bin/docker:ro", "/etc/hostname:/etc/hostname:ro", "/dev:/dev:rw", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.0.7": { "identifier": "f069f86e-9bc5-573f-9c49-020604e09720", "type": "other", "website": null, "images": [ { "expanded_size": 306628412, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:b145ec2696af559d0df0ef81cd3428627332bcc3bab0f6a531b668a4fac63be7" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "vscode", "python", "rust" ], "extra_links": {}, "tag": "1.0.7", "docs": null, "readme": "BlueOS Code Server
\nBlueOS extension for OpenVSCode Server.
\nOpenVSCode server is a project where it provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. It's based on the very same architecture used by Gitpod or GitHub Codespaces at scale.
", "support": null, "requirements": null, "company": null, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata:/home/workspace/userdata:rw", "/usr/blueos/openvscode:/openvscode:rw", "/var/run/docker.sock:/var/run/docker.sock:rw", "/usr/bin/docker:/usr/bin/docker:ro", "/etc/hostname:/etc/hostname:ro", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.0.6": { "identifier": "1aa4f634-c664-5a19-814a-e2f54b1437f3", "type": "other", "website": null, "images": [ { "expanded_size": 306628413, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:a917f9dc8ea4b6c8c55d2d740d28e034ee0e83e46422a8bb6a40e9fe8b8b5af6" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "vscode", "python", "rust" ], "extra_links": {}, "tag": "1.0.6", "docs": null, "readme": "BlueOS Code Server
\nBlueOS extension for OpenVSCode Server.
\nOpenVSCode server is a project where it provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. It's based on the very same architecture used by Gitpod or GitHub Codespaces at scale.
", "support": null, "requirements": null, "company": null, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata:/home/workspace/userdata:rw", "/usr/blueos/openvscode:/openvscode:rw", "/etc/hostname:/etc/hostname:ro", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.0.5": { "identifier": "5a744a04-250a-5e44-a418-c833bc445a98", "type": "other", "website": null, "images": [ { "expanded_size": 306628410, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:fca3d0af07145c5a4b15ed014f9e7db84d2f358b4d22716cf0fda8d31cbc479b" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "vscode", "python", "rust" ], "extra_links": {}, "tag": "1.0.5", "docs": null, "readme": "BlueOS Code Server
\nBlueOS extension for OpenVSCode Server.
\nOpenVSCode server is a project where it provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. It's based on the very same architecture used by Gitpod or GitHub Codespaces at scale.
", "support": null, "requirements": null, "company": null, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata:/home/workspace/userdata:rw", "/usr/blueos/openvscode:/openvscode:rw", "/etc/hostname:/etc/hostname:ro", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.0.4": { "identifier": "15f94a81-695d-530f-bafc-5dcef4bbf61b", "type": "other", "website": null, "images": [ { "expanded_size": 306514789, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:de3c0417bb5f8ff88cefc38e78d8706116d8ae9726c2ab4262af5a7580e7567c" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "vscode", "python", "rust" ], "extra_links": {}, "tag": "1.0.4", "docs": null, "readme": "BlueOS Code Server
\nBlueOS extension for OpenVSCode Server.
\nOpenVSCode server is a project where it provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. It's based on the very same architecture used by Gitpod or GitHub Codespaces at scale.
", "support": null, "requirements": null, "company": null, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata:/home/workspace/userdata:rw", "/usr/blueos/openvscode:/openvscode:rw", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.0.3": { "identifier": "c1d55fdb-fa51-5c81-931b-02931f7c3461", "type": "other", "website": null, "images": [ { "expanded_size": 211619864, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:5647c270f0f05c688748e58912aa139e1d82b8801ccf23b4997631e13f89abe9" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "vscode", "python", "rust" ], "extra_links": {}, "tag": "1.0.3", "docs": null, "readme": "BlueOS Code Server
\nBlueOS extension for OpenVSCode Server.
\nOpenVSCode server is a project where it provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. It's based on the very same architecture used by Gitpod or GitHub Codespaces at scale.
", "support": null, "requirements": null, "company": null, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata:/home/workspace/userdata:rw", "/usr/blueos/openvscode:/openvscode:rw", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.0.2": { "identifier": "acff44bd-868a-5073-8dd0-9de682c36b45", "type": "other", "website": null, "images": [ { "expanded_size": 211619835, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:933474f7fb3e1223b29b1fd6c1b382d8ca40635e2513d322fed6d052f2c2a8f1" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "vscode", "python", "rust" ], "extra_links": {}, "tag": "1.0.2", "docs": null, "readme": "BlueOS Code Server
\nBlueOS extension for OpenVSCode Server.
\nOpenVSCode server is a project where it provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. It's based on the very same architecture used by Gitpod or GitHub Codespaces at scale.
", "support": null, "requirements": null, "company": null, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata:/home/workspace/userdata:rw", "/usr/blueos/openvscode:/openvscode:rw", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.0.1": { "identifier": "7d6e443f-a79b-5590-82e4-482b15e1ed2f", "type": "other", "website": null, "images": [ { "expanded_size": 211619828, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:dee5ee2a9c888be36172b674b9284a9434147874af39ca6680c017de0dfa8610" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "vscode", "python", "rust" ], "extra_links": {}, "tag": "1.0.1", "docs": null, "readme": "BlueOS Code Server
\nBlueOS extension for OpenVSCode Server.
\nOpenVSCode server is a project where it provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. It's based on the very same architecture used by Gitpod or GitHub Codespaces at scale.
", "support": null, "requirements": null, "company": null, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/usr/blueos/userdata:/home/workspace/userdata:rw", "/usr/blueos/openvscode:/openvscode:rw", "/:/home/workspace/host:rw" ], "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } }, "1.0.0": { "identifier": "dcda618a-ffe0-5fc0-8493-847a675d0d09", "type": "other", "website": null, "images": [ { "expanded_size": 211619813, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:fafa0fa8ef1e93fc13f8db0da55157fc95303a4b5c2bccd00cf670aaae8b5d3e" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "code", "development", "ide", "vscode", "python", "rust" ], "extra_links": {}, "tag": "1.0.0", "docs": null, "readme": "BlueOS Code Server
\nBlueOS extension for OpenVSCode Server.
\nOpenVSCode server is a project where it provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. It's based on the very same architecture used by Gitpod or GitHub Codespaces at scale.
", "support": null, "requirements": null, "company": null, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } } }, "repo_info": { "downloads": 49784, "last_updated": "2023-09-06T01:24:53.238154Z", "date_registered": "2023-07-06T13:38:30.979513Z" } }, { "identifier": "bluerobotics.ros", "name": "ROS", "website": "https://github.com/BlueOS-Community/blueos-ros", "docker": "patrickelectric/blueos-ros", "description": "Robot Operating System (ROS) extension for BlueOS", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/ros/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/company_logo.png", "versions": { "0.0.2": { "identifier": "73dc76ed-2f14-5fae-a087-aee4886d5fbd", "type": "other", "website": null, "images": [ { "expanded_size": 370009641, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:75a2bf8947eba791595c30713506e8f94231a656c48f99119c53d17eb09ec72e" }, { "expanded_size": 370009669, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:a9a2112b8cc7df5fefab629d79aa50c7cf68f6f205afe5f7fa44ed343072517a" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "ros", "robot" ], "extra_links": {}, "tag": "0.0.2", "docs": null, "readme": "BlueOS ROS extension
\nThis extension makes possible to communicate with the vehicle via ROS
\nTo connect, you just need to run the following commands:\n```sh\nexport ROS_MASTER_URI=http://blueos.local:11311
\nor export ROS_MASTER_URI=http://:11311
\nrostopic list # Done, you already have access to it!\n```
\nYou can also access the data via roslibjs.
\n```html
\n\n\n\n\n\n\n\n\n\nSimple ROS User Interface
\nConnection status:
\nLast /mavros/vfr_hud received:
\n\n\n```
\nUse a different ROS master origin
\nIt's possible to change ROS master for the extension using BlueOS on pirate mode and configuring ROS environments variables under the extension configuration menu.
\nA valid configurtion wouyld look like this:
\njson5\n{\n \"NetworkMode\": \"host\",\n \"HostConfig\": {\n \"Binds\": [\n \"/dev:/dev:rw\"\n ],\n \"Privileged\": true,\n \"NetworkMode\": \"host\"\n },\n \"Env\": [\n \"ROS_HOSTNAME=192.168.2.2\",\n \"ROS_MASTER_URI=http://192.168.2.3:11311\",\n \"ROS_IP=192.168.2.2\"\n ]\n}
For more information about it, check BlueOS documentation.
", "support": null, "requirements": null, "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Binds": [ "/dev:/dev:rw" ], "Privileged": true, "NetworkMode": "host" } } }, "0.0.1": { "identifier": "e5208a5f-f0e7-5baf-a9b3-d193cc19f3f0", "type": "other", "website": null, "images": [ { "expanded_size": 369666474, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:9b159ab65e4d0b1d541460865aab4cabf9173de7163221d229522cb47a4ae381" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "ros", "robot" ], "extra_links": {}, "tag": "0.0.1", "docs": null, "readme": "BlueOS ROS extension
\nThis extension makes possible to communicate with the vehicle via ROS
\nTo connect, you just need to run the following commands:\n```sh\nexport ROS_MASTER_URI=http://blueos.local:11311
\nor export ROS_MASTER_URI=http://:11311
\nrostopic list # Done, you already have access to it!\n```
\nYou can also access the data via roslibjs.
\n```html
\n\n\n\n\n\n\n\n\n\nSimple ROS User Interface
\nConnection status:
\nLast /mavros/vfr_hud received:
\n\n\n```
\nUse a different ROS master origin
\nIt's possible to change ROS master for the extension using BlueOS on pirate mode and configuring ROS environments variables under the extension configuration menu.
\nA valid configurtion wouyld look like this:
\njson5\n{\n \"NetworkMode\": \"host\",\n \"HostConfig\": {\n \"Binds\": [\n \"/dev:/dev:rw\"\n ],\n \"Privileged\": true,\n \"NetworkMode\": \"host\"\n },\n \"Env\": [\n \"ROS_HOSTNAME=192.168.2.2\",\n \"ROS_MASTER_URI=http://192.168.2.3:11311\",\n \"ROS_IP=192.168.2.2\"\n ]\n}
For more information about it, check BlueOS documentation.
", "support": null, "requirements": null, "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Binds": [ "/dev:/dev:rw" ], "Privileged": true, "NetworkMode": "host" } } } }, "repo_info": { "downloads": 7435, "last_updated": "2025-03-21T12:52:28.85139Z", "date_registered": "2023-09-13T06:14:36.827307Z" } }, { "identifier": "bluerobotics.cellular-modem-manager", "name": "Cellular Modem Manager", "website": "https://github.com/bluerobotics/cellphone-modem-manager", "docker": "bluerobotics/blueos-cellphone-modem-manager", "description": "Blue Robotics cellular modem manager", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/cellular-modem-manager/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/company_logo.png", "versions": { "0.3.3": { "identifier": "28e4dec8-c7a3-565b-ae29-0a16c23906a7", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/cellphone-modem-manager/", "images": [ { "expanded_size": 134736854, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:bb67326df10a86a2d8097dabc9007fc888ebca10e92359748cdfedd269bf4401" }, { "expanded_size": 140908402, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:a2a6c6e3e022506192469762b548dcb31406897260448c70c28675757de92438" }, { "expanded_size": 144572942, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:dbb1ab9a311474b23bd39ad86ce588d4b1988e8d08102b331772fe77cd571565" } ], "authors": [ { "name": "Jo\u00e3o M\u00e1rio Lago", "email": "joaolago@bluerobotics.com" }, { "name": "Willian Galvani", "email": "willian@bluerobotics.com" }, { "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": {}, "tag": "0.3.3", "docs": null, "readme": "Basic extension to manage cellphone modems
", "support": "https://raw.githubusercontent.com/bluerobotics/cellphone-modem-manager/", "requirements": "core >= 1.3", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "20038/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/root/.config:/root/.config", "/dev:/dev:rw" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "20038/tcp": [ { "HostPort": "" } ] } } } }, "0.3.2": { "identifier": "e34bd18a-2b7d-5e51-bd6a-65f32872c70c", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/cellphone-modem-manager/", "images": [ { "expanded_size": 97958127, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:52fcd9a1a1f6862970fd17039fed6b8313cf98e79c0dcb3bdc185af45937d421" }, { "expanded_size": 107310913, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:e5e497dd1725378e308993ad2a71242b92eed00b2048cda0e7e5b051f5fba44d" } ], "authors": [ { "name": "Jo\u00e3o M\u00e1rio Lago", "email": "joaolago@bluerobotics.com" }, { "name": "Willian Galvani", "email": "willian@bluerobotics.com" }, { "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": {}, "tag": "0.3.2", "docs": null, "readme": "Basic extension to manage cellphone modems
", "support": "https://raw.githubusercontent.com/bluerobotics/cellphone-modem-manager/", "requirements": "core >= 1.3", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "20038/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/root/.config:/root/.config", "/dev:/dev:rw" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "20038/tcp": [ { "HostPort": "" } ] } } } }, "0.3.1": { "identifier": "c0792ea7-2d4c-53f2-be8c-dc1f073e7635", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/cellphone-modem-manager/", "images": [ { "expanded_size": 98324590, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:31695cefd4807f1cf0ff29963ce9ba0ae21ec23f599687a2d0d3fbe4e9bfd34e" } ], "authors": [ { "name": "Jo\u00e3o M\u00e1rio Lago", "email": "joaolago@bluerobotics.com" }, { "name": "Willian Galvani", "email": "willian@bluerobotics.com" }, { "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": {}, "tag": "0.3.1", "docs": null, "readme": "Basic extension to manage cellphone modems
", "support": "https://raw.githubusercontent.com/bluerobotics/cellphone-modem-manager/", "requirements": "core >= 1.3", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "20038/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/root/.config:/root/.config", "/dev:/dev:rw" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "20038/tcp": [ { "HostPort": "" } ] } } } }, "0.3.0": { "identifier": "abbfaa33-1f3a-5fc2-a5f2-37873f7d304b", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/cellphone-modem-manager/", "images": [ { "expanded_size": 98147826, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:1deed31f468d4899a9ad6b8b7d3327efb72e475427f9c12ee88effc2668ef91f" } ], "authors": [ { "name": "Jo\u00e3o M\u00e1rio Lago", "email": "joaolago@bluerobotics.com" }, { "name": "Willian Galvani", "email": "willian@bluerobotics.com" }, { "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": {}, "tag": "0.3.0", "docs": null, "readme": "Basic extension to manage cellphone modems
", "support": "https://raw.githubusercontent.com/bluerobotics/cellphone-modem-manager/", "requirements": "core >= 1.3", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "20038/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/root/.config:/root/.config", "/dev:/dev:rw" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "20038/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0": { "identifier": "21bcd310-3940-5f4c-963d-7ca913469063", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/cellphone-modem-manager/", "images": [ { "expanded_size": 98006979, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:2d9c19eea0c360eded692fb5e23d3a7d8bb7146f542e7aeb613f9ef8a245d88d" }, { "expanded_size": 107030530, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:5ca0ce1d54db139f385fe3cd66256f5803ed3ae70ebb28e993f2245d97864dbc" } ], "authors": [ { "name": "Jo\u00e3o M\u00e1rio Lago", "email": "joaolago@bluerobotics.com" }, { "name": "Willian Galvani", "email": "willian@bluerobotics.com" }, { "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": {}, "tag": "0.2.0", "docs": null, "readme": "Basic extension to manage cellphone modems
", "support": "https://raw.githubusercontent.com/bluerobotics/cellphone-modem-manager/", "requirements": "core >= 1.3", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "20038/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/root/.config:/root/.config", "/dev:/dev:rw" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "20038/tcp": [ { "HostPort": "" } ] } } } }, "0.1.0": { "identifier": "14aff5b7-66a0-58e0-9efa-4ae9bc0a1548", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/cellphone-modem-manager/", "images": [ { "expanded_size": 98006170, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:5fdbc09389ee7691c4c5b801c6f071f45d2d153afa375a3c872209870c20f3a2" }, { "expanded_size": 107037533, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:939417b974e09839443fb39e1743ed57214057847548df506b780412fb7a2a39" } ], "authors": [ { "name": "Jo\u00e3o M\u00e1rio Lago", "email": "joaolago@bluerobotics.com" }, { "name": "Willian Galvani", "email": "willian@bluerobotics.com" }, { "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": {}, "tag": "0.1.0", "docs": null, "readme": "Basic extension to manage cellphone modems
", "support": "https://raw.githubusercontent.com/bluerobotics/cellphone-modem-manager/", "requirements": "core >= 1.3", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "20038/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/root/.config:/root/.config", "/dev:/dev:rw" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "20038/tcp": [ { "HostPort": "" } ] } } } } }, "repo_info": { "downloads": 8719, "last_updated": "2025-11-26T19:52:40.880543Z", "date_registered": "2024-12-10T16:34:37.516719Z" } }, { "identifier": "bluerobotics.water-linked-dvl", "name": "Water Linked DVL", "website": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL/", "docker": "bluerobotics/blueos-water-linked-dvl", "description": "Enables ROV position holding and navigation", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/water-linked-dvl/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/company_logo.png", "versions": { "v1.0.10": { "identifier": "c97f7cd7-b8a8-5d46-9e80-ba7f145fc74c", "type": "device-integration", "website": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "images": [ { "expanded_size": 70793987, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:c35c09154d09888a790762abb50420614be63a429f95eee232a54a9ecb3a8ba6" }, { "expanded_size": 75009578, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:ce53a62f2eba8c4a4366871b4f6fc0796c970b828cc416242889e4fcd1045f7b" }, { "expanded_size": 76783323, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:e44f3a7ddce725e6235e8c3e4805438b95a55de85d5f7e47ff971436c827f951" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [ "positioning", "navigation", "doppler-velocity-log" ], "extra_links": {}, "tag": "v1.0.10", "docs": null, "readme": "BlueOS-Water-Linked-DVL
\nChangelog
\nv1.0.10
\n- \n
- Improve DVL finding logic \n
- Refactor settings file \n
v1.0.7
\n- \n
- Fix using lat/long inputs with no internet \n
v1.0.6
\n- \n
- No longer sets parameters automatically. Users can now change for two modes of operation:
- \n
- DVL-only, the recommended mode \n
- DVL+GPS, experimental mode which allows fusing (underwater) GPS and DVL data \n
\n
v1.0.5
\n- \n
- Update texts to make support of DVL A125 obvious \n
v1.0.4
\n- \n
- Fix issue introduced in v1.0.3 where the extension was unable to talk to Cable-guy \n
v1.0.3
\n- \n
- Uses an random available port instead of 9001 to avoid conflict \n
- Updated menu icon \n
v1.0.2
\n- \n
- Improved style \n
v1.0.1
\n- \n
- Fixed an issue where the driver was sending Rangefinder messages with invalid data \n
This is a docker implementation of a Water Linked DVL A50 and A125 driver as a BlueOS Extension.
\nInstall
\nInstall it from BlueOS extensions tab.
\nThe service will show in the \"Extension Manager\" section in BlueOS, where there are some configuration options.
", "support": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "9001/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config:/root/.config" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "9001/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.9": { "identifier": "f6f7e641-213b-548a-89d1-a5ec996d9a1f", "type": "device-integration", "website": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "images": [ { "expanded_size": 70499171, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:f70040ebd2b7373095d9c4866475c6dd7a485336c673924597bd4ca98125a4e8" }, { "expanded_size": 76668659, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:24217099cf3989405e25904469b0eb412213531c058d96cc42f964872583d588" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [ "positioning", "navigation", "doppler-velocity-log" ], "extra_links": {}, "tag": "v1.0.9", "docs": null, "readme": "BlueOS-Water-Linked-DVL
\nChangelog
\nv1.0.7
\n- \n
- Fix using lat/long inputs with no internet \n
v1.0.6
\n- \n
- No longer sets parameters automatically. Users can now change for two modes of operation:
- \n
- DVL-only, the recommended mode \n
- DVL+GPS, experimental mode which allows fusing (underwater) GPS and DVL data \n
\n
v1.0.5
\n- \n
- Update texts to make support of DVL A125 obvious \n
v1.0.4
\n- \n
- Fix issue introduced in v1.0.3 where the extension was unable to talk to Cable-guy \n
v1.0.3
\n- \n
- Uses an random available port instead of 9001 to avoid conflict \n
- Updated menu icon \n
v1.0.2
\n- \n
- Improved style \n
v1.0.1
\n- \n
- Fixed an issue where the driver was sending Rangefinder messages with invalid data \n
This is a docker implementation of a Water Linked DVL A50 and A125 driver as a BlueOS Extension.
\nInstall
\nInstall it from BlueOS extensions tab.
\nThe service will show in the \"Extension Manager\" section in BlueOS, where there are some configuration options.
", "support": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "9001/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config:/root/.config" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "9001/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.8": { "identifier": "19ef5284-1317-5015-8b86-993b64c5929f", "type": "device-integration", "website": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "images": [ { "expanded_size": 70431811, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:5fc14875bc39ee7e24213fe23941fc47c09476f9563abc388e77a2f1f09d04b2" }, { "expanded_size": 76603940, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:0c329808451439ad814a8e70389e36d122916f3120b19ed149eafe7ea5c4b45c" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [ "positioning", "navigation", "doppler-velocity-log" ], "extra_links": {}, "tag": "v1.0.8", "docs": null, "readme": "BlueOS-Water-Linked-DVL
\nChangelog
\nv1.0.7
\n- \n
- Fix using lat/long inputs with no internet \n
v1.0.6
\n- \n
- No longer sets parameters automatically. Users can now change for two modes of operation:
- \n
- DVL-only, the recommended mode \n
- DVL+GPS, experimental mode which allows fusing (underwater) GPS and DVL data \n
\n
v1.0.5
\n- \n
- Update texts to make support of DVL A125 obvious \n
v1.0.4
\n- \n
- Fix issue introduced in v1.0.3 where the extension was unable to talk to Cable-guy \n
v1.0.3
\n- \n
- Uses an random available port instead of 9001 to avoid conflict \n
- Updated menu icon \n
v1.0.2
\n- \n
- Improved style \n
v1.0.1
\n- \n
- Fixed an issue where the driver was sending Rangefinder messages with invalid data \n
This is a docker implementation of a Water Linked DVL A50 and A125 driver as a BlueOS Extension.
\nInstall
\nInstall it from BlueOS extensions tab.
\nThe service will show in the \"Extension Manager\" section in BlueOS, where there are some configuration options.
", "support": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "9001/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config:/root/.config" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "9001/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.7": { "identifier": "bc9d57c3-cf02-5785-bf89-921c450a9fb4", "type": "device-integration", "website": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "images": [ { "expanded_size": 70965287, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:b96869c28654831900781874f50eb75649b5b600a88abdfcbdfb30fc5fcd12e3" }, { "expanded_size": 77097826, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:02b1b004172e7f53009bda575ce76f17b02d02352d195bc7d1caacd9a052ada8" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [ "positioning", "navigation", "doppler-velocity-log" ], "extra_links": {}, "tag": "v1.0.7", "docs": null, "readme": "BlueOS-Water-Linked-DVL
\nChangelog
\nv1.0.7
\n- \n
- Fix using lat/long inputs with no internet \n
v1.0.6
\n- \n
- No longer sets parameters automatically. Users can now change for two modes of operation:
- \n
- DVL-only, the recommended mode \n
- DVL+GPS, experimental mode which allows fusing (underwater) GPS and DVL data \n
\n
v1.0.5
\n- \n
- Update texts to make support of DVL A125 obvious \n
v1.0.4
\n- \n
- Fix issue introduced in v1.0.3 where the extension was unable to talk to Cable-guy \n
v1.0.3
\n- \n
- Uses an random available port instead of 9001 to avoid conflict \n
- Updated menu icon \n
v1.0.2
\n- \n
- Improved style \n
v1.0.1
\n- \n
- Fixed an issue where the driver was sending Rangefinder messages with invalid data \n
This is a docker implementation of a Water Linked DVL A50 and A125 driver as a BlueOS Extension.
\nInstall
\nInstall it from BlueOS extensions tab.
\nThe service will show in the \"Extension Manager\" section in BlueOS, where there are some configuration options.
", "support": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "9001/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config:/root/.config" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "9001/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.6": { "identifier": "5b72c3c7-cc68-5c2c-9edd-b400daa9070d", "type": "device-integration", "website": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "images": [ { "expanded_size": 70955108, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:5c4cc57ab14bbc3c32fc83aefad9f4ef6ab244411b1f80c4511fd6f70535fb48" }, { "expanded_size": 77083331, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:a1486d8026590c4143410fff474811be8d83bd5ae2c80c2f2509bd858b2b6823" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [ "positioning", "navigation", "doppler-velocity-log" ], "extra_links": {}, "tag": "v1.0.6", "docs": null, "readme": "BlueOS-Water-Linked-DVL
\nChangelog
\nv1.0.6
\n- \n
- No longer sets parameters automatically. Users can now change for two modes of operation:
- \n
- DVL-only, the recommended mode \n
- DVL+GPS, experimental mode which allows fusing (underwater) GPS and DVL data \n
\n
v1.0.5
\n- \n
- Update texts to make support of DVL A125 obvious \n
v1.0.4
\n- \n
- Fix issue introduced in v1.0.3 where the extension was unable to talk to Cable-guy \n
v1.0.3
\n- \n
- Uses an random available port instead of 9001 to avoid conflict \n
- Updated menu icon \n
v1.0.2
\n- \n
- Improved style \n
v1.0.1
\n- \n
- Fixed an issue where the driver was sending Rangefinder messages with invalid data \n
This is a docker implementation of a Water Linked DVL A50 and A125 driver as a BlueOS Extension.
\nInstall
\nInstall it from BlueOS extensions tab.
\nThe service will show in the \"Extension Manager\" section in BlueOS, where there are some configuration options.
", "support": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "9001/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config:/root/.config" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "9001/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.5": { "identifier": "d4a8e194-7374-5f38-9e6b-05d689366907", "type": "device-integration", "website": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "images": [ { "expanded_size": 71286141, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:7af61750294fa6eb726e73f855d6ec207ba7bf2c0af1e1ac9626c9e29b54a924" }, { "expanded_size": 77417461, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:6a05bce7c3834c01e2014db273c45e29fa0de985ec5091553f3f4c59d305da62" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [ "positioning", "navigation", "doppler-velocity-log" ], "extra_links": {}, "tag": "v1.0.5", "docs": null, "readme": "BlueOS-Water-Linked-DVL
\nChangelog
\nv1.0.5
\n- \n
- Update texts to make support of DVL A125 obvious \n
v1.0.4
\n- \n
- Fix issue introduced in v1.0.3 where the extension was unable to talk to Cable-guy \n
v1.0.3
\n- \n
- Uses an random available port instead of 9001 to avoid conflict \n
- Updated menu icon \n
v1.0.2
\n- \n
- Improved style \n
v1.0.1
\n- \n
- Fixed an issue where the driver was sending Rangefinder messages with invalid data \n
This is a docker implementation of a Water Linked DVL A50 and A125 driver as a BlueOS Extension.
\nInstall
\nInstall it from BlueOS extensions tab.
\nThe service will show in the \"Extension Manager\" section in BlueOS, where there are some configuration options.
", "support": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "9001/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config:/root/.config" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "9001/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.4": { "identifier": "d28a5218-620a-58c3-8468-46a878b2260a", "type": "device-integration", "website": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "images": [ { "expanded_size": 71246910, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:f8ee948cb512af09d2cab3cc92cc39de0bc802645f382033ba7c5d5972f7c541" }, { "expanded_size": 77377333, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:f366b363ae588f2e2d0d1b69d7b029c9a6974ff6bd8db0c818cc98c81ca8a7fe" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [ "positioning", "navigation", "doppler-velocity-log" ], "extra_links": {}, "tag": "v1.0.4", "docs": null, "readme": "BlueOS-Water-Linked-DVL
\nChangelog
\nv1.0.4
\n- \n
- Fix issue introduced in v1.0.3 where the extension was unable to talk to Cable-guy \n
v1.0.3
\n- \n
- Uses an random available port instead of 9001 to avoid conflict \n
- Updated menu icon \n
v1.0.2
\n- \n
- Improved style \n
v1.0.1
\n- \n
- Fixed an issue where the driver was sending Rangefinder messages with invalid data \n
This is a docker implementation of a Waterlinked DVL A50 driver as a BlueOS Extension.
\nInstall
\nInstall it from BlueOS extensions tab.
\nThe service will show in the \"Extension Manager\" section in BlueOS, where there are some configuration options.
", "support": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "9001/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config:/root/.config" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "9001/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.3": { "identifier": "a6397468-59fb-5808-9706-ea15c6948122", "type": "device-integration", "website": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "images": [ { "expanded_size": 71173047, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:18c4bf17906b278c44e840b40f8561928283ea151f48958ef42dd8ee0d95eb48" }, { "expanded_size": 77304661, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:5c2dd5704cd10b3cf502f3a47d5f9f0283e846e66d3ebcfa7d8ffe5673eb269f" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [ "positioning", "navigation", "doppler-velocity-log" ], "extra_links": {}, "tag": "v1.0.3", "docs": null, "readme": "BlueOS-Water-Linked-DVL
\nChangelog
\nv1.0.3
\n- \n
- Uses an random available port instead of 9001 to avoid conflict \n
- Updated menu icon \n
v1.0.2
\n- \n
- Improved style \n
v1.0.1
\n- \n
- Fixed an issue where the driver was sending Rangefinder messages with invalid data \n
This is a docker implementation of a Waterlinked DVL A50 driver as a BlueOS Extension.
\nInstall
\nInstall it from BlueOS extensions tab.
\nThe service will show in the \"Extension Manager\" section in BlueOS, where there are some configuration options.
", "support": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "9001/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config:/root/.config" ], "PortBindings": { "9001/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.2": { "identifier": "a5416f70-61fe-5098-930b-6fce0d2c0bf4", "type": "other", "website": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "images": [ { "expanded_size": 78844216, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:2f52eb554ba188b329ad06f5167927c54fa773cb33beb6f78a1d2bb3ab991395" }, { "expanded_size": 72588503, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:1e8607b8ea94b70337ada4b84941aa38fcccb06b0c630122d07c2dc66e64630d" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [], "extra_links": {}, "tag": "v1.0.2", "docs": "", "readme": "BlueOS-Water-Linked-DVL
\nChangelog
\nv1.0.2
\n- \n
- Improved style \n
v1.0.1
\n- \n
- Fixed an issue where the driver was sending Rangefinder messages with invalid data \n
This is a docker implementation of a Waterlinked DVL A50 driver as a BlueOS Extension.
\nInstall
\nInstall it from BlueOS extensions tab.
\nThe service will show in the \"Extension Manager\" section in BlueOS, where there are some configuration options.
", "support": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "requirements": "core > 1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "NetworkMode": "host" } }, "v1.0.1": { "identifier": "98ed5b74-52a3-57e1-a100-cbeb698c5498", "type": "other", "website": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "images": [ { "expanded_size": 72798434, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:65115990f649c932a39466fc846aaf671608b441c1e8e8448b8cd4496204d88d" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [], "extra_links": {}, "tag": "v1.0.1", "docs": "", "readme": "BlueOS-Water-Linked-DVL
\nChangelog
\nv1.0.1
\n- \n
- Fixed an issue where the driver was sending Rangefinder messages with invalid data \n
This is a docker implementation of a Waterlinked DVL-a50 driver for the new Blue Robotics BlueOS.
\nTo set this up, ssh into the Raspberry Pi (or access via red-pill in BlueOS Terminal) and run
sudo docker run -d --net=host -v /root/.config/blueos:/root/.config --name=BlueOS-Water-Linked-DVL --restart=unless-stopped bluerobotics/blueos-water-linked-dvl:latest
The service will show in the \"Available Services\" section in BlueOS, where there are some configuration options.
", "support": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "requirements": "core > 1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "NetworkMode": "host" } }, "v1.0.0": { "identifier": "a12a3bf4-23fa-54be-b7af-d4b1598c8246", "type": "other", "website": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "images": [ { "expanded_size": 78926907, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:e3e67687861b5d8c4613e35fafe4f13498c9906e6553125b032f6f6ddf075944" }, { "expanded_size": 72784115, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:daae2a13f71622da16ae0b2a766c3b17b314cf15d538d00112f4036677dad0de" } ], "authors": [ { "name": "Willian Galvani", "email": "willian@bluerobotics.com" } ], "filter_tags": [], "extra_links": {}, "tag": "v1.0.0", "docs": "", "readme": "BlueOS-Water-Linked-DVL
\nThis is a docker implementation of a Waterlinked DVL-a50 driver for the new Blue Robotics BlueOS.
\nTo set this up, ssh into the Raspberry Pi (or access via red-pill in BlueOS Terminal) and run
sudo docker run -d --net=host -v /root/.config/blueos:/root/.config --name=BlueOS-Water-Linked-DVL --restart=unless-stopped bluerobotics/blueos-water-linked-dvl:latest
The service will show in the \"Available Services\" section in BlueOS, where there are some configuration options.
", "support": "https://github.com/bluerobotics/BlueOS-Water-Linked-DVL", "requirements": "core > 1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "NetworkMode": "host" } } }, "repo_info": { "downloads": 260589, "last_updated": "2025-11-26T18:24:22.732171Z", "date_registered": "2022-06-01T23:43:43.19026Z" } }, { "identifier": "bluerobotics.yacht", "name": "Yacht", "website": "https://github.com/BlueOS-Community/blueos-yacht", "docker": "patrickelectric/blueos-yacht", "description": "Easy to use container management utility", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/yacht/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/company_logo.png", "versions": { "1.0.0": { "identifier": "b8ab51f5-90f5-5552-b9fb-43485f0c944d", "type": "tool", "website": null, "images": [ { "expanded_size": 75237108, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:3cbb5d3ccef873e9d2c2f2887d1e833ab1cf74a37dbce0127eecdd93332d33cd" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "docker", "container", "dashboard", "manager" ], "extra_links": {}, "tag": "1.0.0", "docs": null, "readme": "BlueOS yacht
\nYacht is a container management UI with a focus on templates and 1-click deployments.
", "support": null, "requirements": null, "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8000/tcp": {} }, "HostConfig": { "Privileged": true, "Binds": [ "/var/run/docker.sock:/var/run/docker.sock:rw" ], "PortBindings": { "8000/tcp": [ { "HostPort": "" } ] } } } } }, "repo_info": { "downloads": 3113, "last_updated": "2023-09-01T21:07:26.318216Z", "date_registered": "2023-09-01T20:11:40.559943Z" } }, { "identifier": "bluerobotics.navigator-webassistant", "name": "Navigator WebAssistant", "website": "https://github.com/RaulTrombin/blueos-navigator-web-assistant", "docker": "raulelektron/blueos-navigator-webassistant", "description": "Use navigator board through webservices.", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/navigator-webassistant/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/company_logo.png", "versions": { "1.0.0": { "identifier": "70435ffb-6a29-5d30-b1c2-dbc82a34acd4", "type": "education", "website": null, "images": [ { "expanded_size": 32131212, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:de3eb587e89a12bef3bb7e7e701daa56cdf841063df8385b0a91b892b0d918a3" }, { "expanded_size": 32651314, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:f40e068095246755e3790e0dc70f462304671906dec44f3652ad1b727aa9bf4f" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "rov", "robot" ], "extra_links": {}, "tag": "1.0.0", "docs": null, "readme": "BlueOS's Navigator Extension
\nNavigator Webassistant extension is a webserver that allows user to control navigator hardware.\nThis application uses the navigator-assistant to interface with navigator board, and users can control it from Websocket and RestAPI.
\nInstructions
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:\nblueos.local/tools/extensions-manager\nParameters:
```\nraulelektron.blueos_navigator_webassistant
\nNavigator Assistant
\nlatest
\n{\n \"ExposedPorts\": {\n \"8080/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"8080/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n }\n }\n}\n```
\nYou can also run Navigator Assistant locally or on other extensions. Please check navigator-web-assistant.
\nYou can also use the Jupyter extension to try some fast python and websocket applications.
", "support": null, "requirements": null, "company": { "about": "Control navigator hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Privileged": true, "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } } }, "repo_info": { "downloads": 594, "last_updated": "2025-06-18T16:58:38.273351Z", "date_registered": "2025-06-18T15:58:12.81427Z" } }, { "identifier": "bluerobotics.radcam-manager", "name": "RadCam Manager", "website": "https://github.com/bluerobotics/radcam-manager", "docker": "bluerobotics/blueos-radcam-manager", "description": "RadCam's official management interface", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/radcam-manager/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/company_logo.png", "versions": { "0.2.0": { "identifier": "b5535e61-6f8b-526f-a667-8a74819da4ae", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58393909, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:d4c95e42c86fa185abfa78076e09ad0a9a881bd82f4e16e1877d6a9177d50953" }, { "expanded_size": 62806897, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:6610387066e0ed8b4940e5a2a574d8e8b0d30cf7482da45c2605a5f5e3ae385c" }, { "expanded_size": 63450264, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:6cf7ab3bcfa17c6514e457887936eafe38b857ef7a0cd5e3363882efd9eaea19" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4.3\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.17": { "identifier": "bb7ddba4-5e83-508e-8cee-2dd03541ce10", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58393883, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:70dc19a3ea47973f00af6dffeda135f704ad38e01c84a077fec855051904afb0" }, { "expanded_size": 62806857, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:08506f5e9f10ade1a7309f735a4ff6688fbb24e9ff38d4f16383f3428b74fa55" }, { "expanded_size": 63450129, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:8ef166338c1e86b794878d762f0e1f3ede49ffadd98079217f2896a9ef7069ba" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.17", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4.3\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.16": { "identifier": "94cf5593-dec1-5c9b-8335-6395dbf52b4c", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58393808, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:d32e5f62bdf3ea2abdb63b9cf466cf8d354f3e3c0b7f02290d064e1b75f64a52" }, { "expanded_size": 62806748, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:7c302d4da3db50b23d16de53af72585df549d3e0082b1320b7b6c3518d5726c6" }, { "expanded_size": 63450053, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:213478a3e67e020e0a383e358aa7b479d5ce2bd0462aa3a7afe6dd2ca78a4a00" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.16", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4.3\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.15": { "identifier": "20496d66-428c-54c1-8044-fba175e8fdaf", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58394927, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:188cb01146a7a0cd5d62dab5702d31b43036f4ea5f0a5e65f8b7fd112d3d8f63" }, { "expanded_size": 62808815, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:4b91f42fc076952cee5e63397528b2d624c6260562763a5557fbfcec431fde2f" }, { "expanded_size": 63450668, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:84d73ca6541d78531fc88a4051affcfba15229eb999b488a7bd6e4c07fd6a712" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.15", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4.3\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.14": { "identifier": "08ff3960-c25c-5f0c-a9ea-b1bd9d184a4b", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58315260, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:8c393a71190595b8457f1e14178274c5292eb617ac18e1cf31fe3a6dd2122fd6" }, { "expanded_size": 62719278, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:5a39f4e038c5473ef6e443d67956cad523b9d880654f009d573eb497f8840600" }, { "expanded_size": 63368556, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:27e4df26fe17289fe25ccdc59220dd176e914aa6f8f278ffda0a6bd18356a2ed" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.14", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4.3\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.13": { "identifier": "03def0de-e8d2-5021-8bc2-48c65fc0ea86", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58238707, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:2c635a57fb6c729f31bd661cd097c1cd08ba106fe5240d7045a3aea557f29ccd" }, { "expanded_size": 62645588, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:706c571c93e65d178c2e8cacfbdeadeaff4d16d643cb38efc24df5987d81ae5e" }, { "expanded_size": 63294182, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:71044d912f614745b3dc913a1b4b30a4cc955e49fb16a156bf0a971c5e20f753" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.13", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4.3\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.12": { "identifier": "2aaff342-110f-58fe-91d7-f705aa897dc4", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58466781, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:bc74d75d1c3775ea1b77af930b2158a909d842202d00532ab21b1077a21899f6" }, { "expanded_size": 62851262, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:fc4cb599431f69ddd9655b59554d220948d44eacb6aca4bc81ed1aab56204fd1" }, { "expanded_size": 63515635, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:feb6d3e30e40128b68080bb49fc3ef28ec9724aa2a3978c322a63bed20fe8f3c" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.12", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4.3\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.11": { "identifier": "593b4a9a-813a-53b1-bcbf-fc96118f42f4", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58464119, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:b34236c2998375e02a0b47336f179a3cdfb6c7b5de376dd7be0ca160901ddb01" }, { "expanded_size": 62847850, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:ca05894f0f330389b2069570ed9367748cb222ba40a22a75b77e4887eed205dd" }, { "expanded_size": 63513217, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:bb147bef1ccbe6d951fa5810bb9e4930c6aab7b6ca0aa092342fdeee22befb5d" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.11", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4.3\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.10": { "identifier": "aab47e2f-7b9b-5ebe-98b7-3fef1c82838e", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58508876, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:c80d93f88710becd5cce9a8f77df3a00ddf0f0c0aa3519865e3e8cf95135d16a" }, { "expanded_size": 62887979, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:e5ee76f1da8bb70829b95c14d31ab031c90c0312ac8f20fc10fc77e7ee31e0e7" }, { "expanded_size": 63552330, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:be48d33acb70f32fce3569c6d962b2f817d5fda46dfc2f20bf9c2f0ad7be49ed" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.10", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4.3\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.9": { "identifier": "c8abc748-c429-5c57-84aa-c554bb718c93", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58507784, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:afa53b6b6ee02cb58f117da3f7aacfe2a4607038302208713f89dff3c9e8dc36" }, { "expanded_size": 62887216, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:5556a678fd4eedb1aa72c58103bb976ce731e166c5fb2d5916722aa22ebcfda8" }, { "expanded_size": 63551058, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:85e15cc11b1f73b5cd4885b9c9978c9e09cc0d94884b28aa59fecf9eadfa71c4" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.9", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4.3\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.8": { "identifier": "5ae6f327-78bb-570f-adc5-2fd72f493998", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58400366, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:6d75af14f393e98b740d739de413ed3805c3767ae9566503a169403b5e0363ea" }, { "expanded_size": 62738575, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:ed185e66ed70dc73515a9827f5d587cfa14ea1360fcd902faf33f9bd03339a90" }, { "expanded_size": 63436209, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:20393c9f4134308867617654c87a29bfe0108c7a1c027824b581eed355afbadd" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.8", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4.3\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.7": { "identifier": "3f463932-4416-5af5-bd1e-a9015c1aeea9", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58147601, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:095290c2391a34f3654d086e3b442b2394aff62c1bdc2420ba235cdb9ac37c46" }, { "expanded_size": 62498898, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:f5ef5438e306b8fd8be2878ac19eacf6eb04f01f0c3e8e2a9faf94c301036865" }, { "expanded_size": 63194434, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:c53a9a366e03244f9960e9c4d794d675577399157a3861e59071c46b01a0a76b" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.7", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4.3\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.6": { "identifier": "fafb9a08-74d2-585c-8914-a6c7f94c5ba7", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58149928, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:e644dd06a9e053730baabe8468dbe6a85b83d556ee82570bffed68a5f52ca77f" }, { "expanded_size": 62505667, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:3c3f705ceece469afde5ce2c45d238a1344e6f7940482100db3f6eab4596f701" }, { "expanded_size": 63194519, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:0a3a6b74bd8b6549b20778ff517a0a28bb6eb2d9b6a3a90584d47feee59733e4" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.6", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4.3\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.5": { "identifier": "51ac2c9b-7975-5004-9170-919dab6f2183", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58138598, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:77b5574c5550a33d420311228de09b4ba42383d3de3f39ef2b3cb48f94e41ffc" }, { "expanded_size": 62493039, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:73de12f896a4ed17d52d71cd99ce1e003a0c896c35b1d63e75baab0546c53944" }, { "expanded_size": 63181012, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:6ca4118a4cc4db516b0923e23b5715d4039a7cd8ff8b0805dd180559af8b430f" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.5", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.4": { "identifier": "1bdc4b11-486d-51c1-b628-d9f1be2d62d1", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 58096430, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:143f895b9266fa2bbaabc43b0ec26750780e6b45451bca8ee17ba3302ca6ca96" }, { "expanded_size": 62398429, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:bdebf72a7f04af1d9838fcc11e52a69451fcbf768ec910d8e5eecb4ff9aa5316" }, { "expanded_size": 63118667, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:128921739071913be709ad5a8a08a3741b4ccb4b808dfd27a00216064dd89558" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.4", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.3": { "identifier": "ec29c71b-4a91-5848-a17d-dfc2174944eb", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 54374477, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:e1fe257130ab711c180d5fcca916615537dc868a3ee8580b8a58495c52a4bc5c" }, { "expanded_size": 58641446, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:ba52e485a5482eec2915494f27d01bd0ea1d47542417cdc9755a54d2e5d43e6a" }, { "expanded_size": 59238473, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:f57c313d33919ea44d9d75815b10e34694fb11eac1a5465244330c62ef737940" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.3", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.2": { "identifier": "380e4171-6974-5b90-a35f-aff579acd465", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 54372469, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:97075d346074e33aba191817ff7f9b109766f811f00bc30044b3772a73b278bb" }, { "expanded_size": 58639375, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:a02f9f2af18510bc25bcd8f1b2d1abc1a1ece6b260713e8d78d217466f26c6a4" }, { "expanded_size": 59235615, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:40c062062dc562c98f5b43f97954c700da33bdaa30baadd4bd74bd9df8aad15e" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.2", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.2.0-beta.1": { "identifier": "f57f1e1f-66c7-55e1-8cce-2a3a61d2a2af", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 54242846, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:0eb16a1d777143809456c3b9864cb24da97ccc83237d832d0fef3a9adc2616db" }, { "expanded_size": 58487529, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:2b4afcf65d27798966e8fb4b862072ed5008f7eaf555da782cf85d739c3deeaa" }, { "expanded_size": 59074093, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:9120a43f18aa0246afa685158d90d8f4d780ee65d251d9d8101b1b6159a81195" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.2.0-beta.1", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs", "/usr/blueos/extensions/radcam-manager:/app", "/root/.config/blueos/ardupilot-manager/firmware/scripts:/scripts" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.1.4": { "identifier": "7c7e9fa1-3333-5330-8c6a-bfcf74ba1d6e", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 49590303, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:8352d393769c271d5a16189d66fd5248bf169a3ef9834b6969168d16201b3b32" }, { "expanded_size": 53909463, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:256fb3e0bac2ee87ba60f44b7b464562b6a2362f6dc1ab1141e063f14e4ce829" }, { "expanded_size": 54394154, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:827546a0a9ea22ea6eac6a5e04674619fc5409ab16661e6812b535a670aa3f54" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.1.4", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "Binds": [ "/var/logs/blueos/extensions/radcam-manager:/logs" ], "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.1.3": { "identifier": "27983019-45c5-5847-83f4-3399fe56b267", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 49580344, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:01dbfc23dfc8b30041c9ce35a1a02a098a64e4dfeb22202479dd7268c58bd2c7" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.1.3", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } }, "0.1.2": { "identifier": "ba3214c2-03e3-533a-84ec-41aba5cc8ccd", "type": "device-integration", "website": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "images": [ { "expanded_size": 54336039, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:91239451d73a67476b3a348a29c008e45def18801aff6bef2d574d5837725bff" }, { "expanded_size": 58605864, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:d2dce576e9ebf39423261b048ce9accbc04a10424806f667ab91e4349d9d61d4" }, { "expanded_size": 58976404, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:4f8bd482d8debbc6e56044a3c764d755ec7a8dd0bce8c85db9714e2bad515a47" } ], "authors": [ { "name": "Jo\u00e3o Ant\u00f4nio Cardoso", "email": "joao.maker@gmail.com" } ], "filter_tags": [ "rov", "camera", "cam", "radcam", "control" ], "extra_links": {}, "tag": "0.1.2", "docs": null, "readme": "RadCam Manager
\nThis is the official RadCam management interface application.
\nFor the technical read, click here
", "support": "https://raw.githubusercontent.com/bluerobotics/radcam-manager/", "requirements": "[ \"core >= 1.4\", \"cockpit >= 1.7\" ]", "company": { "about": "RadCam's official management interface", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "ExtraHosts": [ "blueos.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } } } } }, "repo_info": { "downloads": 17555, "last_updated": "2026-03-25T17:07:27.426154Z", "date_registered": "2025-01-12T19:20:27.899002Z" } }, { "identifier": "bluerobotics.cockpit", "name": "Cockpit Lite", "website": "https://github.com/bluerobotics/cockpit", "docker": "bluerobotics/cockpit", "description": "Blue Robotics' next generation control interface; under development. Limited by browser.", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/cockpit/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/bluerobotics/company_logo.png", "versions": { "v1.18.0-beta.13": { "identifier": "40e5b65c-58e0-55ca-aaa4-f2a077252bd9", "type": "other", "website": null, "images": [ { "expanded_size": 26775027, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:8c2df72857ff0b7b563ac21cbb027535e3e9f6f609d3eb07c57042e38d84040a" }, { "expanded_size": 26990128, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:991be1ad905b19a5b80b6241cfda47d2be49a5c15083b45642acab50ab79bd31" }, { "expanded_size": 27033684, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:8ca10d091eac3adc7367ba332a691bbf76dbe2b322fbb9a663c97f1548e792d0" } ], "authors": [ { "name": "Rafael Araujo Lehmkuhl", "email": "rafael@bluerobotics.com" }, { "name": "Patrick Jos\u00e9 Pereira", "email": "patrick@bluerobotics.com" }, { "name": "Arturo Manzoli", "email": "arturo@bluerobotics.com" } ], "filter_tags": [ "vehicle-control", "control-station", "ground-station", "navigation", "joystick", "mission-planning" ], "extra_links": {}, "tag": "v1.18.0-beta.13", "docs": null, "readme": "\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\n\n
Cockpit - A Modern Ground Control Software
\n\n\ud83c\udf10 Live Demo \u2022\n \ud83d\udce6 Install \u2022\n \ud83d\udcd6 Documentation \u2022\n \ud83d\udcac Community\n
\n\n
\n
\n
\n
\n
\ud83c\udfaf What is Cockpit?
\nAn intuitive, customizable, and powerful ground control station software for remote vehicles of all types
\nCockpit is a web-based ground control station that aims to improve how you interact with remote vehicles. Whether you're piloting underwater ROVs, surface boats, aerial drones, or ground rovers, Cockpit provides an intuitive and highly customizable interface that adapts to your needs.
\n\u2728 Key Highlights
\n- \n
- \ud83c\udf10 Universal Platform: Runs in your browser or as a native desktop application \n
- \ud83c\udfa8 Fully Customizable: Drag-and-drop widget interface that adapts to your workflow \n
- \ud83d\ude80 Multi-Vehicle Support: Control submarines, boats, drones and rovers from different interfaces in the same application \n
- \ud83d\udcf9 Advanced Video: Support for as many video streams as you need, with recording, snapshots, and real-time statistics \n
- \ud83d\uddfa\ufe0f Mission Planning: Sophisticated waypoint planning with automated survey patterns \n
- \ud83c\udfae Joystick Support: Extensive gamepad support with customizable button mappings \n
- \ud83d\udd27 Extensible: Advanced plugin system with DIY widgets, custom actions, data-lake variables, and input elements \n
- \ud83d\udcca Data Rich: Comprehensive telemetry logging and real-time data visualization \n
\n
\ud83d\ude80 Quick Start
\nAccessing Cockpit
\n- Option 1: Try it Online
\nIf you just want to take a look at Cockpit, you can visit our live demo to experience it instantly in your browser.
\n- Option 2: Download the Native App (Recommended)
\nDownload the latest release of our native desktop app for your platform.\nIt offers the best performance, as well as all the features available in the app.
\nWe have dedicated builds for every Desktop platform, so make sure you're using the correct one to have the best possible experience.\n- Windows: .exe\n- macOS (Intel): x64 .dmg\n- macOS (Apple Silicon): arm64 .dmg\n- Linux: .AppImage\n- Steam OS: .Flatpak
- Option 3: Install the BlueOS Extension (Lite version!)
\nIf you're using BlueOS, you can install Cockpit from the Extensions page.
\n\n\n\u26a0\ufe0f Due to technical limitations of web browsers, the BlueOS Extension has limited functionality compared to the native app.
\nSee below for details.
\n
- Option 4: Docker (for Developers)
\nbash\ndocker run -p 8080:8080 bluerobotics/cockpit:latest
Once you have Cockpit running, it's time to connect to your vehicle:
\nConnecting to your vehicle
\nIf you're running Cockpit as a BlueOS extension, it should automatically connect to your vehicle, but if you're running the native app and you have BlueOS in your vehicle, you can use the Vehicle Discovery dialog to easily connect to it. If for some reason you missed this dialog during boot you can just head to Menu>Settings>General and find the \"Search for vehicles\" button there.
If you have your vehicle connected through a serial interface, like a USB-Serial radio, you should manually configure the connection address. To do that activate the checkmark for \"Mavlink2Rest connection\" under Menu>Settings>General and use serial:path/to/serial/device?baudrate=desired-baudrate there.
Streaming video
\nIf you want to stream video from your vehicle and you're not using BlueOS, you will need to run mavlink-camera-manager manually in the same machine as Cockpit, activate the checkmark for \"WebRTC connection\" and use ws://127.0.0.1:6020 there.
\n
\ud83d\udda5\ufe0f Browser vs Desktop: What's the Difference?
\nMost of the motivation behind having distinct versions with different features is tied to browsers' limitations -- more specifically, the need for secure context to access the most powerful APIs (e.g., filesystem, geolocation, serial communication), which is usually not the case when you're serving Cockpit from a hosted webpage with issued certificates. To overcome this, we moved to shipping additional features in a native app, built over Electron, which also enables us to embed functionality beyond what the browser can provide.
\nBelow is a table summarizing the current status, but in general, you can expect more features and better performance on the native app:
\n\ud83c\udfaf Quick Decision Guide
\nChoose Desktop for complete experience, auto-updates, system integration, and optimal performance.\nChoose Browser for testing, quick access, or when you can't install applications.
\n\n\n\ud83d\udca1 Pro Tip: Start with the live demo to get familiar with Cockpit, then download the desktop app for regular use to unlock all capabilities!
\n
\n
\ud83c\udf9b\ufe0f Supported Vehicles
\nVehicle support is currently focused on ArduPilot-based autopilots communicating over MAVLink.
\nSince Cockpit was created and is maintained by Blue Robotics, we actively test the application every day against ArduSub and ArduRover vehicles, which we sell, so you can expect the best experience with ROVs and boats.
\nWe currently consider the application to fully cover direct control for both submarines and boats, and partially cover automated missions. Currently, Cockpit supports creating missions with basic waypoints and polygon-based surveys. Missions requiring advanced navigation commands and control structures, like loitering, geofencing, and servo control, are not yet supported.
\nAerial vehicles (including those running ArduCopter and ArduPlane autopilot firmware) have initial support, including dedicated widgets for takeoff and landing.
\nArduCopter support has been physically tested, but the primary development team doesn't perform regular tests on any aerial vehicles, so use it at your own risk (also, PRs are very much welcome!).
\n| \n \nSubmarines \nArduSub\n | \n\n \nSurface Boats \nArduRover\n | \n\n \nDrones \nArduCopter\n | \n
\n
\ud83c\udfa8 Features Overview
\n\ud83d\udda5\ufe0f Customizable Interface
\n- \n
- Drag-and-drop widgets for complete layout control \n
- Multiple views for different operational modes \n
- Responsive design that works on almost any screen size \n
- Custom themes with customizable colors and glass effects \n
\ud83c\udfae Vehicle Control
\n- \n
- ArduPilot support for submarines, drones, aerial vehicles and rovers \n
- MAVLink protocol for reliable communication \n
- Joystick integration with support for almost any controller, including custom ones \n
- Custom button mappings for different vehicle types \n
- Real-time telemetry with customizable data displays \n
\ud83d\udcf9 Video Streaming
\n- \n
- WebRTC-based streaming for low-latency video \n
- Multi-stream support with customizable screen placement \n
- Video recording with automatic processing and telemetry overlay generation \n
- Snapshot capture with GPS metadata \n
- Video statistics for monitoring stream quality \n
\ud83d\uddfa\ufe0f Mission Planning
\n- \n
- Interactive map interface with drag-and-drop waypoints \n
- Survey generation for automated area coverage \n
- Points of interest management \n
- Mission import/export for easy backup and reuse \n
- Real-time mission monitoring and execution \n
\ud83d\udcca Data Management
\n- \n
- Data Lake for centralized variable storage and retrieval \n
- Telemetry logging with customizable video overlay \n
- Real-time plotting and indicators for easy visualization \n
\ud83d\udd0c Extensibility
\n- \n
- Plugin architecture for custom widgets \n
- JavaScript API for external integrations \n
- HTTP actions for calling external services \n
- MAVLink actions for sending custom commands \n
- JavaScript actions for completely custom integrations \n
\n
\ud83d\udce6 Available Widgets
\nCockpit provides an extensive list of widgets for you to customize your experience. They are divided into Regular and Mini Widgets and can be placed anywhere on your screen, including freely in your Views or inside Containers like the top and bottom bars.
\nYou can read more about the available widgets in our docs.
\n\n
\ud83d\ude80 Advanced Features
\nOne of our goals in Cockpit is to provide powerful integration tools, so you can interface with any system, no matter how complex it is. To accomplish that, we designed tools like the Cockpit Actions, which allow you to perform custom tasks (e.g., run arbitrary code, call external APIs), and the Data Lake, which provides a centralized place for you to store and retrieve data.
\nBe sure to check our docs for more information on how to take advantage of these powerful tools.
\n\n
\u26a0\ufe0f Current Limitations
\nWhile Cockpit is a powerful and feature-rich ground control station, there are some current limitations to be aware of:
\n\ud83d\ude81 Vehicle Support Gaps
\n- \n
- [PX4 autopilots]: Cockpit's MAVLink functionality is mostly generic, so it is expected that most available features will also work with PX4 autopilot firmware. That said, the core development team does not actively test with PX4 vehicles, so please open a documenting issue (or ideally a solving pull request) for any problems you encounter. \n
- Aerial and Ground vehicles: Although recognized by the application, those types of vehicles have limited support and testing \n
- Contributions welcome: We're actively seeking community help to add support for PX4 vehicles as well as improve the support for Aerial and Ground vehicles on Ardupilot \n
\ud83d\uddfa\ufe0f Mission Planning Limitations
\n- \n
- Geofencing: Not currently supported in mission planning \n
\n\n\ud83d\udca1 Help Us Improve: Many of these limitations represent opportunities for community contributions. Check our GitHub Issues for specific areas where help is needed!
\n
\n
\ud83c\udfd7\ufe0f Architecture
\nCockpit is built with modern web technologies, which help us advance development quickly and easily receive external contributions. Here you can find part of our stack:
\n- \n
- Frontend: Vue.js 3 with TypeScript and Composition API \n
- UI Library: Vuetify 3 for Material Design components \n
- Build System: Vite for fast development and optimized builds \n
- Desktop: Electron for native application packaging \n
- Communication: WebSocket and WebRTC for real-time data \n
\n
\ud83e\udd1d Contributing
\nWe welcome contributions! We don't have a contribution guide yet, but you can help us in different ways:
\n- \n
- \ud83d\udc1b Bug Reports: Help us improve by reporting issues \n
- \ud83d\udca1 Feature Requests: Suggest new capabilities \n
- \ud83d\udd27 Code Contributions: Submit pull requests \n
- \ud83d\udcdd Documentation: Improve our docs and examples \n
\n
\ud83d\udee0\ufe0f Development Setup
\nPrerequisites
\n- \n
- Node.js 18+ and yarn package manager \n
- Git with submodule support \n
Development Workflow
\n- \n
- Fork the repository \n
- Create a feature branch \n
- Make your changes \n
- Submit a pull request \n
Quick Development Start
\n```bash
\nClone with submodules
\ngit clone --recurse-submodules https://github.com/bluerobotics/cockpit.git\ncd cockpit
\nInstall dependencies
\nyarn install
\nStart minimal development server (for testing the Lite version, in a browser)
\nyarn dev
\nStart Electron development server (for testing the full application)
\nyarn dev:electron
\nFix style issues (before making a pull request)
\nyarn lint:fix\n```
\nThe development server will start at http://localhost:5173 with hot reloading enabled.
\n\n\ud83d\udccc Submodules: This repository relies on Git submodules. When submodules are updated (e.g., after pulling changes), run the following command to keep your development environment working:\n
\nbash\ngit submodule update --init --recursive
Testing PR Builds on ARM-based macOS machines (Apple Silicon)
\nPR builds are not code-signed by Apple, so macOS will block them by default via Gatekeeper. To bypass that, after installing the .dmg, run the following command:\nbash\nxattr -d com.apple.quarantine /Applications/Cockpit.app
Backend Services (Optional)
\nFor video support, Cockpit relies on a backend service called mavlink-camera-manager.\nThis service is included by default on BlueOS, but if you want to use Cockpit without BlueOS installed on your vehicle, you should install it in the vehicle or in your top-side computer.
\nVehicle Simulation
\nIf you don't have a vehicle, or prefer to test the application against a simulated one, you can do it with our Docker Compose:\n```bash
\nStart ArduSub simulation
\ndocker-compose -f sim.yml --profile ardusub up
\nOther profiles: arducopter, ardurover, arduplane
\n```
\n\n
\ud83d\udcda Documentation & Support
\n- \n
- \ud83d\udcd6 User Documentation: blueos.cloud/docs/extensions/cockpit \n
- \ud83d\udcac Community Forum: discuss.bluerobotics.com \n
- \ud83d\udc1b Issue Tracker: GitHub Issues \n
- \ud83d\udca1 Feature Requests: GitHub Discussions \n
\n
\ud83d\udcc4 License
\nCockpit is dual-licensed:\n- AGPL-3.0: For open-source use\n- Commercial License: For proprietary applications
\nSee LICENSE.md for details.
\n\n
\ud83c\udfe2 About Blue Robotics
\nOn a mission to enable the future of marine robotics
\n\n\ud83c\udf10 Website \u2022\n \ud83d\udc19 GitHub \u2022\n \ud83d\udcfa YouTube\n
\n\n
\u2b50 Star us on GitHub if you find Cockpit useful!
\nMade with \ud83d\udc99 by the Blue Robotics team and contributors worldwide
\nBlueOS's Ping Viewer Next Extension
\nInstructions
\nManual Instalation
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nbluerobotics.ping-viewer-next
\nPing Viewer Next
\n1.0.0-beta.6
\n{\n \"ExposedPorts\": {\n \"6060/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"6060/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
\nCockpit Widgets
\nFor each connected ping device, provides a widget accessible through Cockpit as an\nAutomatic External Iframe.
\nRequires BlueOS >= 1.4.
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs", "/usr/blueos/extensions/ping-viewer-next/recordings:/app/recordings" ] } } }, "1.0.0-beta.16": { "identifier": "51672c55-a6a8-590f-8240-fce210d58839", "type": "device-integration", "website": null, "images": [ { "expanded_size": 130718740, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:7834f95430d16473fc3ad3c281e5402cb0e3c51e3caad9e3846259eb639fbb7c" }, { "expanded_size": 132511775, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:a8b3630e2f0db07ecd7ab958399d7fb6f4f69b2530168fe874a20c49fc31430b" }, { "expanded_size": 132287510, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:21598ab17dc93119d269ebffa638f19bc6a5808883e2027fe8317db25a23f827" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "sonar", "ping-protocol" ], "extra_links": {}, "tag": "1.0.0-beta.16", "docs": null, "readme": "BlueOS's Ping Viewer Next Extension
\nInstructions
\nManual Instalation
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nbluerobotics.ping-viewer-next
\nPing Viewer Next
\n1.0.0-beta.6
\n{\n \"ExposedPorts\": {\n \"6060/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"6060/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
\nCockpit Widgets
\nFor each connected ping device, provides a widget accessible through Cockpit as an\nAutomatic External Iframe.
\nRequires BlueOS >= 1.4.
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs", "/usr/blueos/extensions/ping-viewer-next/recordings:/app/recordings" ] } } }, "1.0.0-beta.15": { "identifier": "48573733-6aff-5cc3-b637-9e4cb5986ddd", "type": "device-integration", "website": null, "images": [ { "expanded_size": 130710083, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:44aa87b94305f5d34b431d0ddd48c14e1bbe2124b674b5d4484beaefdce783e2" }, { "expanded_size": 132505733, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:ba45f337d000bf234f715c4f34cbe80f938a3ed5ac20050c3f7855779c26cd35" }, { "expanded_size": 132282848, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:a56562c469fc0f8bc937ab9ee83ba86d8e130ec02c26cf22af10a68823ed4f1a" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "sonar", "ping-protocol" ], "extra_links": {}, "tag": "1.0.0-beta.15", "docs": null, "readme": "BlueOS's Ping Viewer Next Extension
\nInstructions
\nManual Instalation
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nbluerobotics.ping-viewer-next
\nPing Viewer Next
\n1.0.0-beta.6
\n{\n \"ExposedPorts\": {\n \"6060/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"6060/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
\nCockpit Widgets
\nFor each connected ping device, provides a widget accessible through Cockpit as an\nAutomatic External Iframe.
\nRequires BlueOS >= 1.4.
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs", "/usr/blueos/extensions/ping-viewer-next/recordings:/app/recordings" ] } } }, "1.0.0-beta.14": { "identifier": "fa4b95b8-28b3-55f8-a84f-96205c0004f2", "type": "device-integration", "website": null, "images": [ { "expanded_size": 130781879, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:aff0919572c441a57cb51d610a1c58cbde8c6eb5b19109f33a6a5494a3ec49f4" }, { "expanded_size": 132549714, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:3d56957d11732560d4228ef9169aab5cff0bc8cb57b12e1186b3eccf9c243df7" }, { "expanded_size": 132391513, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:2fdf3bc204e0191e1a6e4ae7b5f62891812a41455f1cb7a92a6d31c90992fbf2" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "sonar", "ping-protocol" ], "extra_links": {}, "tag": "1.0.0-beta.14", "docs": null, "readme": "BlueOS's Ping Viewer Next Extension
\nInstructions
\nManual Instalation
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nbluerobotics.ping-viewer-next
\nPing Viewer Next
\n1.0.0-beta.6
\n{\n \"ExposedPorts\": {\n \"6060/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"6060/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
\nCockpit Widgets
\nFor each connected ping device, provides a widget accessible through Cockpit as an\nAutomatic External Iframe.
\nRequires BlueOS >= 1.4.
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs", "/usr/blueos/extensions/ping-viewer-next/recordings:/app/recordings" ] } } }, "1.0.0-beta.13": { "identifier": "cdaa0625-4080-522b-ab2a-ec6ba8524a3e", "type": "device-integration", "website": null, "images": [ { "expanded_size": 130759650, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:852a6de44e0510b605d4ba7f1ef876e7127e3da5b82361a3ef498a3bb45409a1" }, { "expanded_size": 132531429, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:7f5937fc73e268fffe00c09ea15e57b351bd13d948eff99ff4a79aa3b72c8053" }, { "expanded_size": 132371017, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:9799e894d1804bb45c33faee760b7dc4af797ecafc587b1cc569336e1f3865ca" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "sonar", "ping-protocol" ], "extra_links": {}, "tag": "1.0.0-beta.13", "docs": null, "readme": "BlueOS's Ping Viewer Next Extension
\nInstructions
\nManual Instalation
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nbluerobotics.ping-viewer-next
\nPing Viewer Next
\n1.0.0-beta.6
\n{\n \"ExposedPorts\": {\n \"6060/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"6060/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
\nCockpit Widgets
\nFor each connected ping device, provides a widget accessible through Cockpit as an\nAutomatic External Iframe.
\nRequires BlueOS >= 1.4.
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs", "/usr/blueos/extensions/ping-viewer-next/recordings:/app/recordings" ] } } }, "1.0.0-beta.12": { "identifier": "1594964d-5a98-5178-ba5d-2f4af7af0b32", "type": "device-integration", "website": null, "images": [ { "expanded_size": 109174215, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:85f0efebd4b3a88bc7ce8069a4243f7307c0a449bf3865e07c2a5836b43930c1" }, { "expanded_size": 107559168, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:0eebf7eeae2da523bdef37e18c5a7767168505fa99b4488d20ab619b70c4cca7" }, { "expanded_size": 109337571, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:0d8f5812e2b76d302415d70927418db6e43369c5b769c360886315760a55d5d4" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "sonar", "ping-protocol" ], "extra_links": {}, "tag": "1.0.0-beta.12", "docs": null, "readme": "BlueOS's Ping Viewer Next Extension
\nInstructions
\nManual Instalation
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nbluerobotics.ping-viewer-next
\nPing Viewer Next
\n1.0.0-beta.6
\n{\n \"ExposedPorts\": {\n \"6060/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"6060/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
\nCockpit Widgets
\nFor each connected ping device, provides a widget accessible through Cockpit as an\nAutomatic External Iframe.
\nRequires BlueOS >= 1.4.
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs", "/usr/blueos/extensions/ping-viewer-next/recordings:/app/recordings" ] } } }, "1.0.0-beta.11": { "identifier": "7a0fa5bb-f700-5211-b046-5ce1acbbd58f", "type": "device-integration", "website": null, "images": [ { "expanded_size": 107570730, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:8552918b24f3472d6bf83d61df64e3bad4527fb669f15cca3a611800843befac" }, { "expanded_size": 109343569, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:4198fd56b168b38a43caa793480ac0fc82c50d573ad836547f1f0d14dce96daa" }, { "expanded_size": 109175399, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:701b49843c5e5e238507a42d0c8130fbdb00c101a9ffb617eaeffa9aaeac91b7" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "sonar", "ping-protocol" ], "extra_links": {}, "tag": "1.0.0-beta.11", "docs": null, "readme": "BlueOS's Ping Viewer Next Extension
\nInstructions
\nManual Instalation
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nbluerobotics.ping-viewer-next
\nPing Viewer Next
\n1.0.0-beta.6
\n{\n \"ExposedPorts\": {\n \"6060/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"6060/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
\nCockpit Widgets
\nFor each connected ping device, provides a widget accessible through Cockpit as an\nAutomatic External Iframe.
\nRequires BlueOS >= 1.4.
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs", "/usr/blueos/extensions/ping-viewer-next/recordings:/app/recordings" ] } } }, "1.0.0-beta.10": { "identifier": "e195f336-fb35-5826-ae9f-0db0491f35ce", "type": "device-integration", "website": null, "images": [ { "expanded_size": 95474107, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:60376c8105f66d141efc8b912495389cb9600dffeb754f77f9e875d88ff2306f" }, { "expanded_size": 93738049, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:624c27016cf1bc8c45b4726d4e2a4a1ae77c78316c86dce2ac795ae307feecde" }, { "expanded_size": 95302854, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:b4386b8fefb39796403c35a632a741ef38a8004cd07ee3655bb7a65c5836009a" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "sonar", "ping-protocol" ], "extra_links": {}, "tag": "1.0.0-beta.10", "docs": null, "readme": "BlueOS's Ping Viewer Next Extension
\nInstructions
\nManual Instalation
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nbluerobotics.ping-viewer-next
\nPing Viewer Next
\n1.0.0-beta.6
\n{\n \"ExposedPorts\": {\n \"6060/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"6060/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
\nCockpit Widgets
\nFor each connected ping device, provides a widget accessible through Cockpit as an\nAutomatic External Iframe.
\nRequires BlueOS >= 1.4.
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs", "/usr/blueos/extensions/ping-viewer-next/recordings:/app/recordings" ] } } }, "1.0.0-beta.9": { "identifier": "f48e432e-f7d1-5e81-8662-151dd1a86174", "type": "device-integration", "website": null, "images": [ { "expanded_size": 93740408, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:8c2e45c46491962d27858a6972dfcf4d98f19dd2fe94b477959e4764a726751c" }, { "expanded_size": 95281256, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:271a7c560f37648313a8482c57ab61a576ba9b08051a5e0417a9b1f7d5f824b9" }, { "expanded_size": 95257664, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:dca9b8afff5a2279c868d3e94bb09b89bce58f7e51cc718288ddde02ef27eddc" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "sonar", "ping-protocol" ], "extra_links": {}, "tag": "1.0.0-beta.9", "docs": null, "readme": "BlueOS's Ping Viewer Next Extension
\nInstructions
\nManual Instalation
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nbluerobotics.ping-viewer-next
\nPing Viewer Next
\n1.0.0-beta.6
\n{\n \"ExposedPorts\": {\n \"6060/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"6060/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
\nCockpit Widgets
\nFor each connected ping device, provides a widget accessible through Cockpit as an\nAutomatic External Iframe.
\nRequires BlueOS >= 1.4.
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs", "/usr/blueos/extensions/ping-viewer-next/recordings:/app/recordings" ] } } }, "1.0.0-beta.8": { "identifier": "8d104cbf-926e-5d43-be07-d560eaa3eae8", "type": "device-integration", "website": null, "images": [ { "expanded_size": 69717483, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:fdd42befee90ceddf9309f6ff0d542c65e0a54ba360d337e8ff53e37d0e4d90b" }, { "expanded_size": 71305228, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:293b42b7bfa916414ae09d9de098f2c26d6e64e3fe4f16b9d8b1627523f6ac0a" }, { "expanded_size": 71146357, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:201a1d28fbdfdf3a933b61812e01f07651439e188c5d3b1c4c919a645694d0a2" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "sonar", "ping-protocol" ], "extra_links": {}, "tag": "1.0.0-beta.8", "docs": null, "readme": "BlueOS's Ping Viewer Next Extension
\nInstructions
\nManual Instalation
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nbluerobotics.ping-viewer-next
\nPing Viewer Next
\n1.0.0-beta.6
\n{\n \"ExposedPorts\": {\n \"6060/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"6060/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
\nCockpit Widgets
\nFor each connected ping device, provides a widget accessible through Cockpit as an\nAutomatic External Iframe.
\nRequires BlueOS >= 1.4.
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs", "/usr/blueos/extensions/ping-viewer-next/recordings:/app/recordings" ] } } }, "1.0.0-beta.7": { "identifier": "94592f21-3c85-5b91-b107-88cd2dd0a7cd", "type": "device-integration", "website": null, "images": [ { "expanded_size": 69716844, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:5151c04f3120594eb31350b8604eac8434c0ec51359c2db6b0c743b724913010" }, { "expanded_size": 71305380, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:47b56ff781dc1f81dbf637959febc7773fe7032fcbb57282726371773c88e5eb" }, { "expanded_size": 71146639, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:93793f93b4c2c5955b12d308554fb607d9ca3322e8f8bac3b601686bec5b631d" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "sonar", "ping-protocol" ], "extra_links": {}, "tag": "1.0.0-beta.7", "docs": null, "readme": "BlueOS's Ping Viewer Next Extension
\nInstructions
\nManual Instalation
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nbluerobotics.ping-viewer-next
\nPing Viewer Next
\n1.0.0-beta.6
\n{\n \"ExposedPorts\": {\n \"6060/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"6060/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
\nCockpit Widgets
\nFor each connected ping device, provides a widget accessible through Cockpit as an\nAutomatic External Iframe.
\nRequires BlueOS >= 1.4.
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs" ] } } }, "1.0.0-beta.6": { "identifier": "c5d72555-9554-57c0-b153-a070d3e67143", "type": "device-integration", "website": null, "images": [ { "expanded_size": 67578651, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:ec60fc73d20a0675d80124b14b6cd96f10acab00359eae440b2ef062636ebcae" }, { "expanded_size": 69218619, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:745ab26cc518cba1d701c0dcc6ca4b31750c6629e138e5579482cecfc9d5b62b" }, { "expanded_size": 69029826, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:b91256b8c53c4e98ad7b1301c096c5572ef6242949f2046aeddc3c1af27f33b0" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "sonar", "ping-protocol" ], "extra_links": {}, "tag": "1.0.0-beta.6", "docs": null, "readme": "BlueOS's Ping Viewer Next Extension
\nInstructions
\nManual Instalation
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nbluerobotics.ping-viewer-next
\nPing Viewer Next
\n1.0.0-beta.6
\n{\n \"ExposedPorts\": {\n \"6060/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"6060/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
\nCockpit Widgets
\nFor each connected ping device, provides a widget accessible through Cockpit as an\nAutomatic External Iframe.
\nRequires BlueOS >= 1.4.
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs" ] } } }, "1.0.0-beta.5": { "identifier": "192bc28a-6abd-5d03-aeff-1940078a7a4c", "type": "education", "website": null, "images": [ { "expanded_size": 66844751, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:cb538b36b713081458cf25a42e8a55a67154f1471685a63f7380a1e9890cc69f" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "rov", "robot" ], "extra_links": {}, "tag": "1.0.0-beta.5", "docs": null, "readme": "BlueOS's Ping Viewer Next Extension
\nInstructions
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nraulelektron.ping-viewer-next
\nPing Viewer Next
\n0.0.0
\n{\n \"ExposedPorts\": {\n \"8080/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"8080/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs" ] } } }, "1.0.0-beta.4": { "identifier": "3435f8ae-2417-5e6d-93fa-85dcb553d51b", "type": "education", "website": null, "images": [ { "expanded_size": 66778448, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:53abba4e8472e41fc2f150a64ce6df8a3afeb8347c085b59fd24d3a0186f7a5b" }, { "expanded_size": 68169943, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:1eddb2da1fa5bc7a520455b4c872c4b97ed4d5e91bde15d90f7303c490d6763e" } ], "authors": [ { "name": "Raul Victor Trombin", "email": "raulvtrombin@gmail.com" } ], "filter_tags": [ "rov", "robot" ], "extra_links": {}, "tag": "1.0.0-beta.4", "docs": null, "readme": "BlueOS's Ping Viewer Next Extension
\nInstructions
\nAccess the extensions manager and install with the following parameters:
\nExtensions Manager:
\nshell\nblueos.local/tools/extensions-manager
Parameters:
\n```shell\nraulelektron.ping-viewer-next
\nPing Viewer Next
\n0.0.0
\n{\n \"ExposedPorts\": {\n \"8080/tcp\": {}\n },\n \"HostConfig\": {\n \"Privileged\": true,\n \"PortBindings\": {\n \"8080/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n },\n \"NetworkMode\": \"host\"\n }\n}\n```
", "support": null, "requirements": null, "company": { "about": "Control PingProtocol based hardware using webservices", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "6060/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/usr/blueos/extensions/ping-viewer-next/logs:/app/logs" ] } } } }, "repo_info": { "downloads": 10278, "last_updated": "2026-03-16T23:21:06.030866Z", "date_registered": "2025-01-27T19:05:48.437826Z" } }, { "identifier": "rafaellehmkuhl.websocket-streamer-for-cockpit", "name": "Data Streaming to Cockpit via WebSocket (Example Extension)", "website": "https://github.com/rafaellehmkuhl/BlueOS-WebSocket-Server-For-Cockpit-Extension", "docker": "rafaellehmkuhl/blueos-websocket-server-for-cockpit", "description": "Example extension demonstrating how to create a WebSocket server that streams data-lake variables to Cockpit.", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/rafaellehmkuhl/websocket-streamer-for-cockpit/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/rafaellehmkuhl/company_logo.png", "versions": { "0.1.2": { "identifier": "0ce8ff91-6d3a-50af-88ff-612d4641f5d5", "type": "example", "website": "https://github.com/rafaellehmkuhl/BlueOS-WebSocket-Server-For-Cockpit-Extension", "images": [ { "expanded_size": 49928806, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:eed5c78076a4f3c73efde7654ccd516c5be6af52ef37498197e1d7ccb4a321d2" }, { "expanded_size": 50224721, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:6be20f6e54b4878cb60c0676887d008d072927bed6627eb8d30842ec131fdbf3" }, { "expanded_size": 45675955, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:a8a32c040d89e863902a017a29c57c63af9ae05ddfd74489a3e87657f6b24e80" } ], "authors": [ { "name": "Rafael Araujo Lehmkuhl", "email": "rafael.lehmkuhl93@gmail.com" } ], "filter_tags": [ "websocket", "cockpit", "data-lake" ], "extra_links": {}, "tag": "0.1.2", "docs": null, "readme": "No README available", "support": "https://github.com/rafaellehmkuhl/BlueOS-WebSocket-Server-For-Cockpit-Extension/issues", "requirements": null, "company": { "about": "Blue Robotics - Underwater Robotics Made Accessible", "name": "Blue Robotics", "email": "rafael@bluerobotics.com" }, "permissions": { "HostConfig": { "NetworkMode": "host" } } }, "0.1.1": { "identifier": "0132057e-425a-521a-903d-7287a2d6087b", "type": "example", "website": "https://github.com/rafaellehmkuhl/BlueOS-WebSocket-Server-For-Cockpit-Extension", "images": [ { "expanded_size": 49928859, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:8283528a72ca878aeacad0885ccee2bbc2029a58961ed6ecf772dc892c7fbf9f" }, { "expanded_size": 50224902, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:7643370e25a169fdfd68a899b7abbe011a00fd89e3152fd06a4cf29dc380c7fa" }, { "expanded_size": 45675979, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:f59183d51d9e6c174efbf3e0a3e3d93c7bb21e4d93bf88f5b9ead88d373107aa" } ], "authors": [ { "name": "Rafael Araujo Lehmkuhl", "email": "rafael.lehmkuhl93@gmail.com" } ], "filter_tags": [ "websocket", "cockpit", "data-lake" ], "extra_links": {}, "tag": "0.1.1", "docs": null, "readme": "No README available", "support": "https://github.com/rafaellehmkuhl/BlueOS-WebSocket-Server-For-Cockpit-Extension/issues", "requirements": null, "company": { "about": "Blue Robotics - Underwater Robotics Made Accessible", "name": "Blue Robotics", "email": "rafael@bluerobotics.com" }, "permissions": { "ExposedPorts": { "8765/tcp": {} }, "HostConfig": { "PortBindings": { "8765/tcp": [ { "HostPort": "8765" } ] } } } } }, "repo_info": { "downloads": 735, "last_updated": "2026-01-30T21:25:13.839149Z", "date_registered": "2026-01-30T20:31:13.810756Z" } }, { "identifier": "sonardyne.navsync_pro", "name": "Sonardyne: NavSync Pro", "website": "https://github.com/Sonardyne/blueos-sprint-nav-extension", "docker": "sonardyne/blueos-sprint-nav-extension", "description": "An extension that uses SPRINT-Nav HNav data to provide position updates to the BlueROV. This allows both vehicle tracking and position hold.", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/sonardyne/navsync_pro/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/sonardyne/company_logo.png", "versions": { "v1.0.10": { "identifier": "ca834222-ab59-58c9-a1ec-6a8ba75feeed", "type": "device-integration", "website": "https://www.sonardyne.com/", "images": [ { "expanded_size": 326153248, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:98454a27945e1515788576cf14782bf6550761b78400fe1e761480c9daed4cf1" }, { "expanded_size": 326156296, "platform": { "architecture": "arm", "variant": "v8", "os": "linux" }, "digest": "sha256:77dc04bf8a94b6094daca84d1e89581efaa6b654533531ec722723e0fd7aeaa4" }, { "expanded_size": 359823688, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:5cec900d5a78a0b66b424305f05288dc9f0f847f5d9d9a399dd4c60e19ff8bf4" } ], "authors": [ { "name": "Sonardyne International Limited", "email": "support@sonardyne.com" } ], "filter_tags": [ "positioning", "navigation", "dvl", "ins", "position-hold" ], "extra_links": {}, "tag": "v1.0.10", "docs": null, "readme": "", "support": "https://www.sonardyne.com/support-centre/", "requirements": null, "company": { "about": "", "name": "Sonardyne International Limited", "email": "support@sonardyne.com" }, "permissions": { "NetworkMode": "host", "ExposedPorts": { "9091/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev:/dev", "/usr/blueos/extensions/data-logger:/webui/logs" ], "PortBindings": { "9091/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.9": { "identifier": "2532abcd-7f2f-51dc-806c-a3b63dce9a57", "type": "device-integration", "website": "https://www.sonardyne.com/", "images": [ { "expanded_size": 687453125, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:f2983ab3732954ec5dcab7b8ff36297f4bf8b88b0659606222a1f7cf2bbe7600" }, { "expanded_size": 687450722, "platform": { "architecture": "arm", "variant": "v8", "os": "linux" }, "digest": "sha256:e38a76e1c7cb366151a42ccf2148c9dbdcd21c67b343fb95f4fd9ecde56132c9" }, { "expanded_size": 734876911, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:93107377ac320ccdd1c11106025e7d1d3fa8dc164fec6b5c1b6c25c1549ccf5c" } ], "authors": [ { "name": "Sonardyne International Limited", "email": "support@sonardyne.com" } ], "filter_tags": [ "positioning", "navigation", "dvl", "ins", "position-hold" ], "extra_links": {}, "tag": "v1.0.9", "docs": null, "readme": "", "support": "https://www.sonardyne.com/support-centre/", "requirements": null, "company": { "about": "", "name": "Sonardyne International Limited", "email": "support@sonardyne.com" }, "permissions": { "NetworkMode": "host", "ExposedPorts": { "9091/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev:/dev", "/usr/blueos/extensions/data-logger:/webui/logs" ], "PortBindings": { "9091/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.8": { "identifier": "5b6cf889-1de8-56a9-a624-4353959f380f", "type": "device-integration", "website": "https://www.sonardyne.com/", "images": [ { "expanded_size": 550240488, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:c4f7b5de29b423fdc57713525bf15968716de88d80dae000949947b4adef5ea2" }, { "expanded_size": 564014391, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:f094c40df5262fa2632cfbe64f12b3d74e7bcb4529ba0cb733e47d4628aee5ae" }, { "expanded_size": 579809042, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:e56302ce656c6e4f09f560f2aea5d2ea340be69ec97a0b17e39b03e993c1ccab" } ], "authors": [ { "name": "Sonardyne International Limited", "email": "support@sonardyne.com" } ], "filter_tags": [ "positioning", "navigation", "dvl", "ins", "position-hold" ], "extra_links": {}, "tag": "v1.0.8", "docs": null, "readme": "", "support": "https://www.sonardyne.com/support-centre/", "requirements": null, "company": { "about": "", "name": "Sonardyne International Limited", "email": "support@sonardyne.com" }, "permissions": { "NetworkMode": "host", "ExposedPorts": { "9091/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev:/dev", "/usr/blueos/extensions/data-logger:/webui/logs" ], "PortBindings": { "9091/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.7": { "identifier": "175c6cca-c4c6-5a27-a878-96f8458d701d", "type": "device-integration", "website": "https://www.sonardyne.com/", "images": [ { "expanded_size": 550721782, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:8a8f30f7b9c8c2640fcfd3ef1626c10fa3f0d3a3b6d9d0275ee9c860dd9c7ed5" }, { "expanded_size": 564201748, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:5f602f289e90a3271012076544f8791500543b20b656d193479e9b922183d677" }, { "expanded_size": 581063638, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:d56a22d957b00e417fa7dd7a540889d4d23161216cbe2814de2176e8eec04924" } ], "authors": [ { "name": "Sonardyne International Limited", "email": "support@sonardyne.com" } ], "filter_tags": [ "positioning", "navigation", "dvl", "ins", "position-hold" ], "extra_links": {}, "tag": "v1.0.7", "docs": null, "readme": "", "support": "https://www.sonardyne.com/support-centre/", "requirements": null, "company": { "about": "", "name": "Sonardyne International Limited", "email": "support@sonardyne.com" }, "permissions": { "NetworkMode": "host", "ExposedPorts": { "9091/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev:/dev", "/usr/blueos/extensions/data-logger:/webui/logs" ], "PortBindings": { "9091/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.6": { "identifier": "99679a4d-e956-5010-af0c-ee08127e7c27", "type": "device-integration", "website": "https://www.sonardyne.com/", "images": [ { "expanded_size": 543935068, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:09406e970a2bc715b3e383b396fd4b03dd6b083247168fe666b3a48b8a9ea472" }, { "expanded_size": 557308877, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:0d35f9e0b0cee572a1a815de6aa744f85b67842bd3a0d33308c148e2e20aca11" }, { "expanded_size": 573073438, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:36bcf2800f4d9ef5d970e53c647898671cd78175a43aa82f9b1ecc11b5061431" } ], "authors": [ { "name": "Sonardyne International Limited", "email": "support@sonardyne.com" } ], "filter_tags": [ "positioning", "navigation", "dvl", "ins", "position-hold" ], "extra_links": {}, "tag": "v1.0.6", "docs": null, "readme": "", "support": "https://www.sonardyne.com/support-centre/", "requirements": null, "company": { "about": "", "name": "Sonardyne International Limited", "email": "support@sonardyne.com" }, "permissions": { "NetworkMode": "host", "ExposedPorts": { "9091/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev:/dev", "/usr/blueos/extensions/data-logger:/webui/logs" ], "PortBindings": { "9091/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.5": { "identifier": "26d37fab-0109-500f-8e05-94c18f55246f", "type": "device-integration", "website": "https://www.sonardyne.com/", "images": [ { "expanded_size": 543876880, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:f19c446693d4f581c9c4f419572a90cdaa3ab53efd62c31e44c3227ca2168d12" }, { "expanded_size": 557304774, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:1d20c095a811e48724e50c70003e729cfa710d113bdc30659f77a8ebf588d81f" }, { "expanded_size": 573014975, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:4316ddf7c214e90636d2b84e3350ff1395dfaba20fc5920c904a6fb7c2fd1cf5" } ], "authors": [ { "name": "Sonardyne International Limited", "email": "support@sonardyne.com" } ], "filter_tags": [ "positioning", "navigation", "dvl", "ins", "position-hold" ], "extra_links": {}, "tag": "v1.0.5", "docs": null, "readme": "", "support": "https://www.sonardyne.com/support-centre/", "requirements": null, "company": { "about": "", "name": "Sonardyne International Limited", "email": "support@sonardyne.com" }, "permissions": { "NetworkMode": "host", "ExposedPorts": { "9091/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev:/dev", "/usr/blueos/extensions/data-logger:/webui/logs" ], "PortBindings": { "9091/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.4": { "identifier": "27832fd3-fbf3-5858-a829-02e11b852d90", "type": "device-integration", "website": "https://www.sonardyne.com/", "images": [ { "expanded_size": 543868925, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:208e65a722024e93143a194a3002af2e488b0e3b74a5d2051a2db832ac7e1cb3" }, { "expanded_size": 557287579, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:9ed2221422a828912ce848048821cb6d6d9e8d4dbae465dffe3fe24009447039" }, { "expanded_size": 573029012, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:19c7ba226a9fed80cc401aef0483e85346664430b17ecbcd4e36cf8d5bd63a27" } ], "authors": [ { "name": "Sonardyne International Limited", "email": "support@sonardyne.com" } ], "filter_tags": [ "positioning", "navigation", "dvl", "ins", "position-hold" ], "extra_links": {}, "tag": "v1.0.4", "docs": null, "readme": "", "support": "https://www.sonardyne.com/support-centre/", "requirements": null, "company": { "about": "", "name": "Sonardyne International Limited", "email": "support@sonardyne.com" }, "permissions": { "NetworkMode": "host", "ExposedPorts": { "9091/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev:/dev", "/usr/blueos/extensions/data-logger:/webui/logs" ], "PortBindings": { "9091/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.3": { "identifier": "511895ee-ff95-5882-8098-b19fd1934774", "type": "device-integration", "website": "https://www.sonardyne.com/", "images": [ { "expanded_size": 543867774, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:78beaabd0a70d25ef5bc85157e1122421ef9f8c421f9869096e9b73e8e57eedd" }, { "expanded_size": 557268813, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:12670a0f7b0ed6e9c17ad44049e1f64837f95b0e410f59e3b6fb5007982384b1" }, { "expanded_size": 573010895, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:64ac8ba3d889896bec419d2bf09d52af507d43b4c0ac77452f861e7a8b37fd8d" } ], "authors": [ { "name": "Sonardyne International Limited", "email": "support@sonardyne.com" } ], "filter_tags": [ "positioning", "navigation", "dvl", "ins", "position-hold" ], "extra_links": {}, "tag": "v1.0.3", "docs": null, "readme": "", "support": "https://www.sonardyne.com/support-centre/", "requirements": null, "company": { "about": "", "name": "Sonardyne International Limited", "email": "support@sonardyne.com" }, "permissions": { "NetworkMode": "host", "ExposedPorts": { "9091/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev:/dev", "/usr/blueos/extensions/data-logger:/webui/logs" ], "PortBindings": { "9091/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.2": { "identifier": "87b57f15-256e-5a94-a475-d561c83dfdc4", "type": "device-integration", "website": "https://www.sonardyne.com/", "images": [ { "expanded_size": 543881443, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:41d260710ff0cdbb41f2ff5469518b8870823a069578601b9a9b0bbec475721b" }, { "expanded_size": 557323967, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:0840f1d861197945db98b0ca17c2211dca2b039494b18ec259f6866400a5be68" }, { "expanded_size": 573055046, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:76d2a668ec8d8fdbbc82e0807a3b54b1002bed73f6a2a65f8d0d46dadce21987" } ], "authors": [ { "name": "Sonardyne International Limited", "email": "support@sonardyne.com" } ], "filter_tags": [ "positioning", "navigation", "dvl", "ins", "position-hold" ], "extra_links": {}, "tag": "v1.0.2", "docs": null, "readme": "No README available", "support": "https://www.sonardyne.com/support-centre/", "requirements": null, "company": { "about": "", "name": "Sonardyne International Limited", "email": "support@sonardyne.com" }, "permissions": { "NetworkMode": "host", "ExposedPorts": { "9091/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev:/dev", "/usr/blueos/extensions/data-logger:/webui/logs" ], "PortBindings": { "9091/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.1": { "identifier": "783baccc-23cf-51ed-b6eb-d682fa3b85ab", "type": "device-integration", "website": "https://www.sonardyne.com/", "images": [ { "expanded_size": 543877988, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:c363af047b2c531181ed31c09b9d5b5a971b1e16400a5bac1691de08d265064b" }, { "expanded_size": 557310517, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:dee41c5e5aa8ab7cab546fe9ec34113afc0ba430a05a10be8d45e513ad7372d5" }, { "expanded_size": 573060500, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:aa8af326413f95815ed47cd54d3d994c156c9a3526a932dcd25cd609c061498f" } ], "authors": [ { "name": "Sonardyne International Limited", "email": "support@sonardyne.com" } ], "filter_tags": [ "positioning", "navigation", "dvl", "ins", "position-hold" ], "extra_links": {}, "tag": "v1.0.1", "docs": null, "readme": "No README available", "support": "https://www.sonardyne.com/support-centre/", "requirements": null, "company": { "about": "", "name": "Sonardyne International Limited", "email": "support@sonardyne.com" }, "permissions": { "NetworkMode": "host", "ExposedPorts": { "9091/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev:/dev", "/usr/blueos/extensions/data-logger:/webui/logs" ], "PortBindings": { "9091/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.0": { "identifier": "ccd83cc9-03fe-5b6e-986c-aa768c4e3224", "type": "device-integration", "website": "https://www.sonardyne.com/", "images": [ { "expanded_size": 543897122, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:4eca4dbd894c55822394eebc93cf01070157dc57d1e5b754cd01562eb42efb4a" } ], "authors": [ { "name": "Sonardyne International Limited", "email": "support@sonardyne.com" } ], "filter_tags": [ "positioning", "navigation", "dvl", "ins", "position-hold" ], "extra_links": {}, "tag": "v1.0.0", "docs": null, "readme": "No README available", "support": "https://www.sonardyne.com/support-centre/", "requirements": null, "company": { "about": "", "name": "Sonardyne International Limited", "email": "support@sonardyne.com" }, "permissions": { "NetworkMode": "host", "ExposedPorts": { "9091/tcp": {} }, "HostConfig": { "Privileged": true, "NetworkMode": "host", "Binds": [ "/dev:/dev", "/usr/blueos/extensions/data-logger:/webui/logs" ] } } } }, "repo_info": { "downloads": 25698, "last_updated": "2026-02-11T11:25:19.836431Z", "date_registered": "2024-09-16T13:23:53.464854Z" } }, { "identifier": "itskalvik.ros2", "name": "ROS2", "website": "https://github.com/itskalvik/blueos-ros2", "docker": "itskalvik/blueos-ros2", "description": "Robot Operating System 2 (ROS2) extension for BlueOS", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/itskalvik/ros2/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/itskalvik/company_logo.png", "versions": { "0.1.0": { "identifier": "3635e6e0-4c90-564e-ae80-871466f46749", "type": "other", "website": null, "images": [ { "expanded_size": 910795950, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:3146714ba9c54e70304ae3efd219dbe53047b9ff450183c3e25098bbbfc82a7f" }, { "expanded_size": 807160158, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:bcac5259321c2a1caa991b2a0f221f69552532757675c0210d726f31cd53d33d" } ], "authors": [ { "name": "Kalvik Jakkala", "email": "itskalvik@gmail.com" } ], "filter_tags": [ "ros2", "sonar", "camera", "foxglove", "navigation", "mapping", "data-collection", "communication", "interaction", "positioning" ], "extra_links": {}, "tag": "0.1.0", "docs": null, "readme": "\n\n\n
The BlueOS ROS2 Extension bridges the BlueOS and ROS2 ecosystems, enabling advanced robotic applications and research on ArduPilot-based vehicles such as the BlueBoat and BlueROV2.
\nThis extension provides drivers and tools for controlling vehicles and visualizing onboard sensor data. It simplifies the process of setting up a ROS 2 environment for marine robotics by offering pre-configured packages for sonar, cameras, and vehicle control\u2014ready to use out of the box.
\nIn addition, it includes a web-based terminal for convenient access to the ROS 2 environment and integrates seamlessly with Foxglove for browser-based data visualization.
\n\n![](\"https://raw.githubusercontent.com/itskalvik/blueos-ros2/master/.assets/demo.gif\")
\n
\ud83d\ude80 Features
\nThis extension includes the following ROS 2 Jazzy packages:
\n- \n
- mavros_control \n
A Python-based control interface built on MAVROS\n * Supports GPS waypoint navigation (BlueBoat) and RC control (BlueROV2)\n * Includes methods for arming/disarming, takeoff/landing, setting home location, and waypoint following\n * Easily subclass or use as-is to skip writing repetitive boilerplate code
\n- \n
- gscam2 \n
A ROS 2 driver for GStreamer-based video streams, with support for intra-process communication to maximize performance.
\n\nDrivers for Blue Robotics Ping1D altimeter and Ping360 scanning sonar.\n * Nodes for direct hardware interfacing and real-time data visualization
\n- \n
- sonoptix_sonar \n
Drivers and data processing tools for the Sonoptix Echo sonar.\n * Nodes for direct hardware interfacing and real-time data visualization
\n\nA WebSocket bridge to stream ROS 2 data into the Foxglove web interface.\n * Fully compatible with the BlueOS Foxglove plugin
\n\ud83d\udccb Prerequisites
\n- \n
- A 64-bit version of BlueOS is required. \n
\ud83d\udc49 Download the latest Raspberry Pi image from the BlueOS Releases page.
\n\ud83e\uddf0 Installation
\nYou can install the ROS 2 Extension directly from the BlueOS App Store
\n\n![](\"https://raw.githubusercontent.com/itskalvik/blueos-ros2/master/.assets/installation.gif\")
\n
\u2699\ufe0f Usage
\n- \n
- Automatic Launch: The extension launches automatically when BlueOS boots. \n
- Web Terminal: Access the extension\u2019s terminal via the left-hand panel in the BlueOS UI. \n
- Persistent Storage: The extension links the following directories \n
- Host path:
/usr/blueos/extensions/ros2/\n - Container path:
/root/persistent_ws/\n
Use this to store files like custom ROS 2 workspaces or configuration files that need to survive reboots.
\n\n![](\"https://raw.githubusercontent.com/itskalvik/blueos-ros2/master/.assets/usage.gif\")
\n
\ud83d\udee0\ufe0f Build and Run Locally
\nTo build the extension for multiple architectures (arm64, amd64) using Docker:
1. Set Up Multi-Architecture Builder
\nbash\ndocker buildx create --name multi-arch \\\n --platform \"linux/arm64,linux/amd64\" \\\n --driver \"docker-container\"\ndocker buildx use multi-arch
2. Clone the Repository and Build the Container
\nbash\ngit clone --recurse-submodules https://github.com/itskalvik/blueos-ros2\ncd blueos-ros2\ndocker compose build
3. Run the Container
\nbash\ndocker compose up -d
The extension will be accessible at: http://localhost:4717/
\n\ud83e\udd13 Manual Installation in BlueOS
\n- \n
- Connect to BlueOS in your browser: \n
- Via Wi-Fi AP: http://blueos-hotspot.local/ \n
- On the same network: http://blueos-avahi.local/ \n
- Navigate to the
Extensionstab, then switch to theINSTALLEDtab. \n - Click the
+button (bottom-right), and fill in the fields:- \n
- Extension Identifier:
ItsKalvik.ROS2\n - Extension Name:
ROS2\n - Docker image:
YOURDOCKERHUBUSER/YOURDOCKERHUBREPO\n - Docker tag:
latest\n - Original Settings:\n
json\n {\n \"NetworkMode\": \"host\",\n \"HostConfig\": {\n \"Binds\": [\n \"/dev:/dev:rw\",\n \"/usr/blueos/extensions/ros2/:/root/persistent_ws/:rw\"\n ],\n \"Privileged\": true,\n \"NetworkMode\": \"host\",\n \"CpuQuota\": 200000,\n \"CpuPeriod\": 100000,\n \"Memory\": 1097152000\n },\n \"Env\": []\n }\n
\n - Extension Identifier:
- Click
CREATEto complete the installation. \n
\n\n\n
The BlueOS ROS2 Extension bridges the BlueOS and ROS2 ecosystems, enabling advanced robotic applications and research on ArduPilot-based vehicles such as the BlueBoat and BlueROV2.
\nThis extension provides drivers and tools for controlling vehicles and visualizing onboard sensor data. It simplifies the process of setting up a ROS 2 environment for marine robotics by offering pre-configured packages for sonar, cameras, and vehicle control\u2014ready to use out of the box.
\nIn addition, it includes a web-based terminal for convenient access to the ROS 2 environment and integrates seamlessly with Foxglove for browser-based data visualization.
\n\n\n
\ud83d\ude80 Features
\nThis extension includes the following ROS 2 Jazzy packages:
\n- \n
- mavros_control \n
A Python-based control interface built on MAVROS\n * Supports GPS waypoint navigation (BlueBoat) and RC control (BlueROV2)\n * Includes methods for arming/disarming, takeoff/landing, setting home location, and waypoint following\n * Easily subclass or use as-is to skip writing repetitive boilerplate code
\n- \n
- gscam2 \n
A ROS 2 driver for GStreamer-based video streams, with support for intra-process communication to maximize performance.
\n\nDrivers for Blue Robotics Ping1D altimeter and Ping360 scanning sonar.\n * Nodes for direct hardware interfacing and real-time data visualization
\n- \n
- sonoptix_sonar \n
Drivers and data processing tools for the Sonoptix Echo sonar.\n * Nodes for direct hardware interfacing and real-time data visualization
\n\nA WebSocket bridge to stream ROS 2 data into the Foxglove web interface.\n * Fully compatible with the BlueOS Foxglove plugin
\n\ud83d\udccb Prerequisites
\n- \n
- A 64-bit version of BlueOS is required. \n
\ud83d\udc49 Download the latest Raspberry Pi image from the BlueOS Releases page.
\n\ud83e\uddf0 Installation
\nYou can install the ROS 2 Extension directly from the BlueOS App Store
\n\n\n
\u2699\ufe0f Usage
\n- \n
- Automatic Launch: The extension launches automatically when BlueOS boots. \n
- Web Terminal: Access the extension\u2019s terminal via the left-hand panel in the BlueOS UI. \n
- Persistent Storage: The extension links the following directories \n
- Host path:
/usr/blueos/extensions/ros2/\n - Container path:
/root/persistent_ws/\n
Use this to store files like custom ROS 2 workspaces or configuration files that need to survive reboots.
\n\n\n
\ud83d\udee0\ufe0f Build and Run Locally
\nTo build the extension for multiple architectures (arm64, amd64) using Docker:
1. Set Up Multi-Architecture Builder
\nbash\ndocker buildx create --name multi-arch \\\n --platform \"linux/arm64,linux/amd64\" \\\n --driver \"docker-container\"\ndocker buildx use multi-arch
2. Clone the Repository and Build the Container
\nbash\ngit clone --recurse-submodules https://github.com/itskalvik/blueos-ros2\ncd blueos-ros2\ndocker compose build
3. Run the Container
\nbash\ndocker compose up -d
The extension will be accessible at: http://localhost:4717/
\n\ud83e\udd13 Manual Installation in BlueOS
\n- \n
- Connect to BlueOS in your browser: \n
- Via Wi-Fi AP: http://blueos-hotspot.local/ \n
- On the same network: http://blueos-avahi.local/ \n
- Navigate to the
Extensionstab, then switch to theINSTALLEDtab. \n - Click the
+button (bottom-right), and fill in the fields:- \n
- Extension Identifier:
ItsKalvik.ROS2\n - Extension Name:
ROS2\n - Docker image:
YOURDOCKERHUBUSER/YOURDOCKERHUBREPO\n - Docker tag:
latest\n - Original Settings:\n
json\n {\n \"NetworkMode\": \"host\",\n \"HostConfig\": {\n \"Binds\": [\n \"/dev:/dev:rw\",\n \"/usr/blueos/extensions/ros2/:/root/persistent_ws/:rw\"\n ],\n \"Privileged\": true,\n \"NetworkMode\": \"host\",\n \"CpuQuota\": 200000,\n \"CpuPeriod\": 100000,\n \"Memory\": 1097152000\n },\n \"Env\": []\n }\n
\n - Extension Identifier:
- Click
CREATEto complete the installation. \n
\n\n\n
The BlueOS ROS2 Extension bridges the BlueOS and ROS2 ecosystems, enabling advanced robotic applications and research on ArduPilot-based vehicles such as the BlueBoat and BlueROV2.
\nThis extension provides drivers and tools for controlling vehicles and visualizing onboard sensor data. It simplifies the process of setting up a ROS 2 environment for marine robotics by offering pre-configured packages for sonar, cameras, and vehicle control\u2014ready to use out of the box.
\nIn addition, it includes a web-based terminal for convenient access to the ROS 2 environment and integrates seamlessly with Foxglove for browser-based data visualization.
\n\n\n
\ud83d\ude80 Features
\nThis extension includes the following ROS 2 Jazzy packages:
\n- \n
- mavros_control \n
A Python-based control interface built on MAVROS\n * Supports GPS waypoint navigation (BlueBoat) and RC control (BlueROV2)\n * Includes methods for arming/disarming, takeoff/landing, setting home location, and waypoint following\n * Easily subclass or use as-is to skip writing repetitive boilerplate code
\n- \n
- gscam2 \n
A ROS 2 driver for GStreamer-based video streams, with support for intra-process communication to maximize performance.
\n\nDrivers for Blue Robotics Ping1D altimeter and Ping360 scanning sonar.\n * Nodes for direct hardware interfacing and real-time data visualization
\n- \n
- sonoptix_sonar \n
Drivers and data processing tools for the Sonoptix Echo sonar.\n * Nodes for direct hardware interfacing and real-time data visualization
\n\nA WebSocket bridge to stream ROS 2 data into the Foxglove web interface.\n * Fully compatible with the BlueOS Foxglove plugin
\n\ud83d\udccb Prerequisites
\n- \n
- A 64-bit version of BlueOS is required. \n
\ud83d\udc49 Download the latest Raspberry Pi image from the BlueOS Releases page.
\n\ud83e\uddf0 Installation
\nYou can install the ROS 2 Extension directly from the BlueOS App Store
\n\n\n
\u2699\ufe0f Usage
\n- \n
- Automatic Launch: The extension launches automatically when BlueOS boots. \n
- Web Terminal: Access the extension\u2019s terminal via the left-hand panel in the BlueOS UI. \n
- Persistent Storage: The extension links the following directories \n
- Host path:
/usr/blueos/extensions/ros2/\n - Container path:
/root/persistent_ws/\n
Use this to store files like custom ROS 2 workspaces or configuration files that need to survive reboots.
\n\n\n
\ud83d\udee0\ufe0f Build and Run Locally
\nTo build the extension for multiple architectures (arm64, amd64) using Docker:
1. Set Up Multi-Architecture Builder
\nbash\ndocker buildx create --name multi-arch \\\n --platform \"linux/arm64,linux/amd64\" \\\n --driver \"docker-container\"\ndocker buildx use multi-arch
2. Clone the Repository and Build the Container
\nbash\ngit clone --recurse-submodules https://github.com/itskalvik/blueos-ros2\ncd blueos-ros2\ndocker compose build
3. Run the Container
\nbash\ndocker compose up -d
The extension will be accessible at: http://localhost:4717/
\n\ud83e\udd13 Manual Installation in BlueOS
\n- \n
- Connect to BlueOS in your browser: \n
- Via Wi-Fi AP: http://blueos-hotspot.local/ \n
- On the same network: http://blueos-avahi.local/ \n
- Navigate to the
Extensionstab, then switch to theINSTALLEDtab. \n - Click the
+button (bottom-right), and fill in the fields:- \n
- Extension Identifier:
ItsKalvik.ROS2\n - Extension Name:
ROS2\n - Docker image:
YOURDOCKERHUBUSER/YOURDOCKERHUBREPO\n - Docker tag:
latest\n - Original Settings:\n
json\n {\n \"NetworkMode\": \"host\",\n \"HostConfig\": {\n \"Binds\": [\n \"/dev:/dev:rw\",\n \"/usr/blueos/extensions/ros2/:/root/persistent_ws/:rw\"\n ],\n \"Privileged\": true,\n \"NetworkMode\": \"host\",\n \"CpuQuota\": 200000,\n \"CpuPeriod\": 100000,\n \"Memory\": 1097152000\n },\n \"Env\": []\n }\n
\n - Extension Identifier:
- Click
CREATEto complete the installation. \n
\n\n\n
The BlueOS ROS2 Extension bridges the BlueOS and ROS2 ecosystems, enabling advanced robotic applications and research on ArduPilot-based vehicles such as the BlueBoat and BlueROV2.
\nThis extension provides drivers and tools for controlling vehicles and visualizing onboard sensor data. It simplifies the process of setting up a ROS 2 environment for marine robotics by offering pre-configured packages for sonar, cameras, and vehicle control\u2014ready to use out of the box.
\nIn addition, it includes a web-based terminal for convenient access to the ROS 2 environment and integrates seamlessly with Foxglove for browser-based data visualization.
\n\n\n
\ud83d\ude80 Features
\nThis extension includes the following ROS 2 Jazzy packages:
\n- \n
- mavros_control \n
A Python-based control interface built on MAVROS\n * Supports GPS waypoint navigation (BlueBoat) and RC control (BlueROV2)\n * Includes methods for arming/disarming, takeoff/landing, setting home location, and waypoint following\n * Easily subclass or use as-is to skip writing repetitive boilerplate code
\n- \n
- gscam2 \n
A ROS 2 driver for GStreamer-based video streams, with support for intra-process communication to maximize performance.
\n\nDrivers for Blue Robotics Ping1D altimeter and Ping360 scanning sonar.\n * Nodes for direct hardware interfacing and real-time data visualization
\n- \n
- sonoptix_sonar \n
Drivers and data processing tools for the Sonoptix Echo sonar.\n * Nodes for direct hardware interfacing and real-time data visualization
\n\nA WebSocket bridge to stream ROS 2 data into the Foxglove web interface.\n * Fully compatible with the BlueOS Foxglove plugin
\n\ud83d\udccb Prerequisites
\n- \n
- A 64-bit version of BlueOS is required. \n
\ud83d\udc49 Download the latest Raspberry Pi image from the BlueOS Releases page.
\n\ud83e\uddf0 Installation
\nYou can install the ROS 2 Extension directly from the BlueOS App Store
\n\n\n
\u2699\ufe0f Usage
\n- \n
- Automatic Launch: The extension launches automatically when BlueOS boots. \n
- Web Terminal: Access the extension\u2019s terminal via the left-hand panel in the BlueOS UI. \n
- Persistent Storage: The extension links the following directories \n
- Host path:
/usr/blueos/extensions/ros2/\n - Container path:
/root/persistent_ws/\n
Use this to store files like custom ROS 2 workspaces or configuration files that need to survive reboots.
\n\n\n
\ud83d\udee0\ufe0f Build and Run Locally
\nTo build the extension for multiple architectures (arm64, amd64) using Docker:
1. Set Up Multi-Architecture Builder
\nbash\ndocker buildx create --name multi-arch \\\n --platform \"linux/arm64,linux/amd64\" \\\n --driver \"docker-container\"\ndocker buildx use multi-arch
2. Clone the Repository and Build the Container
\nbash\ngit clone --recurse-submodules https://github.com/itskalvik/blueos-ros2\ncd blueos-ros2\ndocker compose build
3. Run the Container
\nbash\ndocker compose up -d
The extension will be accessible at: http://localhost:4717/
\n\ud83e\udd13 Manual Installation in BlueOS
\n- \n
- Connect to BlueOS in your browser: \n
- Via Wi-Fi AP: http://blueos-hotspot.local/ \n
- On the same network: http://blueos-avahi.local/ \n
- Navigate to the
Extensionstab, then switch to theINSTALLEDtab. \n - Click the
+button (bottom-right), and fill in the fields:- \n
- Extension Identifier:
ItsKalvik.ROS2\n - Extension Name:
ROS2\n - Docker image:
YOURDOCKERHUBUSER/YOURDOCKERHUBREPO\n - Docker tag:
latest\n - Original Settings:\n
json\n {\n \"NetworkMode\": \"host\",\n \"HostConfig\": {\n \"Binds\": [\n \"/dev:/dev:rw\",\n \"/usr/blueos/extensions/ros2/:/root/persistent_ws/:rw\"\n ],\n \"Privileged\": true,\n \"NetworkMode\": \"host\",\n \"CpuQuota\": 200000,\n \"CpuPeriod\": 100000,\n \"Memory\": 1097152000\n },\n \"Env\": []\n }\n
\n - Extension Identifier:
- Click
CREATEto complete the installation. \n
\n\n\n
The BlueOS ROS2 Extension bridges the BlueOS and ROS2 ecosystems, enabling advanced robotic applications and research on ArduPilot-based vehicles such as the BlueBoat and BlueROV2.
\nThis extension provides drivers and tools for controlling vehicles and visualizing onboard sensor data. It simplifies the process of setting up a ROS 2 environment for marine robotics by offering pre-configured packages for sonar, cameras, and vehicle control\u2014ready to use out of the box.
\nIn addition, it includes a web-based terminal for convenient access to the ROS 2 environment and integrates seamlessly with Foxglove for browser-based data visualization.
\n\n\n
\ud83d\ude80 Features
\nThis extension includes the following ROS 2 Jazzy packages:
\n- \n
- mavros_control \n
A Python-based control interface built on MAVROS\n * Supports GPS waypoint navigation (BlueBoat) and RC control (BlueROV2)\n * Includes methods for arming/disarming, takeoff/landing, setting home location, and waypoint following\n * Easily subclass or use as-is to skip writing repetitive boilerplate code
\n- \n
- gscam2 \n
A ROS 2 driver for GStreamer-based video streams, with support for intra-process communication to maximize performance.
\n\nDrivers for Blue Robotics Ping1D altimeter and Ping360 scanning sonar.\n * Nodes for direct hardware interfacing and real-time data visualization
\n- \n
- sonoptix_sonar \n
Drivers and data processing tools for the Sonoptix Echo sonar.\n * Nodes for direct hardware interfacing and real-time data visualization
\n\nA WebSocket bridge to stream ROS 2 data into the Foxglove web interface.\n * Fully compatible with the BlueOS Foxglove plugin
\n\ud83d\udccb Prerequisites
\n- \n
- A 64-bit version of BlueOS is required. \n
\ud83d\udc49 Download the latest Raspberry Pi image from the BlueOS Releases page.
\n\ud83e\uddf0 Installation
\nYou can install the ROS 2 Extension directly from the BlueOS App Store
\n\n\n
\u2699\ufe0f Usage
\n- \n
- Automatic Launch: The extension launches automatically when BlueOS boots. \n
- Web Terminal: Access the extension\u2019s terminal via the left-hand panel in the BlueOS UI. \n
- Persistent Storage: The extension links the following directories \n
- Host path:
/usr/blueos/extensions/ros2/\n - Container path:
/root/persistent_ws/\n
Use this to store files like custom ROS 2 workspaces or configuration files that need to survive reboots.
\n\n\n
\ud83d\udee0\ufe0f Build and Run Locally
\nTo build the extension for multiple architectures (arm64, amd64) using Docker:
1. Set Up Multi-Architecture Builder
\nbash\ndocker buildx create --name multi-arch \\\n --platform \"linux/arm64,linux/amd64\" \\\n --driver \"docker-container\"\ndocker buildx use multi-arch
2. Clone the Repository and Build the Container
\nbash\ngit clone --recurse-submodules https://github.com/itskalvik/blueos-ros2\ncd blueos-ros2\ndocker compose build
3. Run the Container
\nbash\ndocker compose up -d
The extension will be accessible at: http://localhost:4717/
\n\ud83e\udd13 Manual Installation in BlueOS
\n- \n
- Connect to BlueOS in your browser: \n
- Via Wi-Fi AP: http://blueos-hotspot.local/ \n
- On the same network: http://blueos-avahi.local/ \n
- Navigate to the
Extensionstab, then switch to theINSTALLEDtab. \n - Click the
+button (bottom-right), and fill in the fields:- \n
- Extension Identifier:
ItsKalvik.ROS2\n - Extension Name:
ROS2\n - Docker image:
YOURDOCKERHUBUSER/YOURDOCKERHUBREPO\n - Docker tag:
latest\n - Original Settings:\n
json\n {\n \"NetworkMode\": \"host\",\n \"HostConfig\": {\n \"Binds\": [\n \"/dev:/dev:rw\",\n \"/usr/blueos/extensions/ros2/:/root/persistent_ws/:rw\"\n ],\n \"Privileged\": true,\n \"NetworkMode\": \"host\",\n \"CpuQuota\": 200000,\n \"CpuPeriod\": 100000,\n \"Memory\": 1097152000\n },\n \"Env\": []\n }\n
\n - Extension Identifier:
- Click
CREATEto complete the installation. \n
A BlueOS extension that enables fully autonomous and adaptive bathymetric surveys on the BlueBoat and any ArduPilot-based ASV using SGP-Tools. Powered by the latest research in Informative Path Planning (IPP).
\n\ud83c\udf1f Features
\n- \n
- \n
Automatic Waypoint Generation: Generates efficient survey routes from your QGroundControl geofence polygon.
\n \n - \n
Autonomous & Adaptive Missions: Arms, runs, and disarms the ASV automatically, adapting routes in real time based on sensor data.
\n \n - \n
Supported Sensors: Works with Ping1D, GPS, and more (fully configurable in config.yaml).
\n \n - \n
Persistent Data Logging: Stores mission logs and collected data as HDF5 files for post-mission analysis and map reconstruction.
\n \n - \n
Onboard Visualization: Easily publish mission results for real-time or offline viewing in Foxglove or Jupyter Notebook.
\n \n - \n
Easy Plan Upload: Drag and drop QGroundControl plan files with geofence directly into
\n/usr/blueos/extensions/sgptools. \n - \n
Web Terminal Access: Launch, debug, and analyze missions through the BlueOS browser UI.
\n \n - \n
Configurable & Extensible: Quickly modify sensors, mission types, and planner options via YAML config\u2014add new models with ease.
\n \n - \n
Integrated Simulator: Test, develop, and validate survey missions in a realistic Gazebo & SITL environment using our dedicated simulator docker container.
\n \n - \n
Minimal Setup: Installs in seconds from the BlueOS App Store; no complex setup required.
\n \n - \n
Multi-Arch & Platform Support: Runs on ARM64 (Raspberry Pi), AMD64, and any ArduPilot-compatible ASV with sufficient memory (4GB+). |
\n \n
\ud83d\udccb Prerequisites
\n- \n
- 64-bit BlueOS running on Raspberry Pi 4 or similar (ARM64) or AMD64 platform \n
- At least 4GB RAM + swap (see Swap Setup below) \n
- Compatible sensors (e.g., Ping1D sonar) \n
\ud83e\uddf0 Installation
\nInstall Directly from the BlueOS App Store
\n- \n
- Open BlueOS in your browser (e.g.,
http://blueos.local/) \n - Go to Extensions tab \n
- Find SGP-Tools in the App Store and click Install \n
- The extension will auto-launch on boot \n
\u2699\ufe0f Usage
\nUpload Your Survey Area Plan
\n- \n
- Use QGroundControl to draw your geofence and home position \n
- \n
Save as
mission.plan\n\n\n\n![](\"https://raw.githubusercontent.com/itskalvik/docker-sgp-tools/refs/heads/main/robot-docker/../.assets/generate_plan.gif\")
\n \n - \n
Upload to
/usr/blueos/extensions/sgptools/in BlueOS (usingFile BrowserinPirate Mode)\n\n\n\n![](\"https://raw.githubusercontent.com/itskalvik/docker-sgp-tools/refs/heads/main/robot-docker/../.assets/upload_mission.gif\")
\n \n
Configure (Optional)
\n- \n
- \n
Advanced users can edit
\n/root/config.yamlin the SGP-Tools web terminal to:- \n
- Select/modify sensor config \n
- Change mission type (
AdaptiveIPP,IPP,Waypoint) \n - Adjust optimization parameters \n
See the ros_sgp_tools README for configuration details.
\n \n
Start Your Mission
\n- \n
- Open the SGP-Tools web terminal from the BlueOS UI (left menu) \n
- \n
Start the planner:\n
\nros2 launch ros_sgp_tools asv.launch.py- \n
- The vehicle will arm, start the survey, and collect data automatically \n
\n\n\n![](\"https://raw.githubusercontent.com/itskalvik/docker-sgp-tools/refs/heads/main/robot-docker/../.assets/start_mission.gif\")
\n \n
Data Visualization
\n- \n
- After the mission, you can visualize collected data via:\n
ros2 launch ros_sgp_tools visualize_data.launch.py\n - \n
Then open Foxglove in your browser, and connect to your ASV\u2019s IP to view the bathymetry data
\n \n - \n
\u26a0\ufe0f Do not run this during the mission, as it will disrupt the path planner
\n\n\n\n![](\"https://raw.githubusercontent.com/itskalvik/docker-sgp-tools/refs/heads/main/robot-docker/../.assets/data_viz.gif\")
\n \n
\ud83d\udcbe Persistent Storage
\nThe extension maps:
\n- \n
- Host:
/usr/blueos/extensions/sgptools/\n - Container:
/root/ros2_ws/src/ros_sgp_tools/launch/data/\n
This directory is persistent and stores:
\n- \n
mission.plan\nconfig.yaml\n- All mission logs:
IPP-mission-<timestamp>/\n - Swap configuration script:
config_swap.sh\n
\ud83e\udde0 Swap Setup & Memory Requirements
\n- \n
- At least 4GB of RAM or swap is required. \n
- The extension includes a swap configuration script:\n
/usr/blueos/extensions/sgptools/config_swap.sh\n - \n
Increase swap (if needed):
\n- \n
- In BlueOS, open a terminal (Pirate Mode), then run: \n
\nbash\nred-pill
\nbash\nsudo bash /usr/blueos/extensions/sgptools/config_swap.sh\n
\ud83e\uddea Simulation & Testing with the SGP-Tools Simulator
\nWant to experiment, develop, or validate missions before deploying to the water?
\nThe docker-sgp-tools repository includes a fully integrated Gazebo simulator container with all the tools you need for realistic software-in-the-loop (SITL) testing.
\n\ud83d\ude80 Simulator Features
\n- \n
- \n
Gazebo Simulation: Realistic 3D environment with the BlueBoat ASV model and waves.
\n \n - \n
ArduPilot SITL: Software-in-the-loop autopilot runs your real survey missions.
\n \n - \n
SGP-Tools & ROS 2: The full path planning stack, exactly as on your robot.
\n \n
\ud83d\udcdd Notes and Troubleshooting
\n- \n
- \n
Extension won\u2019t launch / out of memory:
\nRun the swap setup, and ensure enough memory is available.
\n \n - \n
No mission data or logs:
\nMake sure the
\nPing 1Dport is correctly listed in theconfig.yaml\n - \n
Cannot connect via Foxglove:
\nVerify network settings, and that Foxglove bridge is running.
\n \n
\ud83d\udcda More Info & Documentation
\n- \n
- SGP-Tools project site \n
- ros_sgp_tools package \n
- SGP-Tools Docker images \n
- QGroundControl plan files \n
- BlueOS Docs \n
\u26a0\ufe0f Disclaimer
\nThis extension, when executed properly, will take control of the ASV and could potentially collide the vehicle with obstacles in the environment. Please use it with caution.
", "support": null, "requirements": null, "company": { "about": "", "name": "ItsKalvik", "email": "itskalvik@gmail.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Binds": [ "/dev:/dev:rw", "/usr/blueos/extensions/sgptools/:/root/ros2_ws/src/ros_sgp_tools/launch/data/:rw" ], "Privileged": true, "NetworkMode": "host" }, "Env": [ "DATA_FOLDER=/root/ros2_ws/src/ros_sgp_tools/launch/data/", "FCU_URL=tcp://0.0.0.0:5777@", "ROS_LOG_DIR=/root/ros2_ws/src/ros_sgp_tools/launch/data/logs/", "RCUTILS_COLORIZED_OUTPUT=1" ] } }, "0.0.2": { "identifier": "06ef47a9-9da7-5fd3-81dd-a869bfe90664", "type": "other", "website": null, "images": [ { "expanded_size": 1330267526, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:feaff8281f4695e26622373134325beb2960f653d66816b6c604af50b0123c10" }, { "expanded_size": 1779937606, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:7e19e8f1117dd38480f59c896c8ce5dd0feb2a204a2e5b013f6a5c12abdcec66" } ], "authors": [ { "name": "Kalvik Jakkala", "email": "itskalvik@gmail.com" } ], "filter_tags": [ "ros2", "sonar", "camera", "foxglove", "navigation", "mapping", "data-collection", "communication", "interaction", "positioning" ], "extra_links": {}, "tag": "0.0.2", "docs": null, "readme": "A BlueOS extension that enables fully autonomous and adaptive bathymetric surveys on the BlueBoat and any ArduPilot-based ASV using SGP-Tools. Powered by the latest research in Informative Path Planning (IPP).
\n\ud83c\udf1f Features
\n- \n
- \n
Automatic Waypoint Generation: Generates efficient survey routes from your QGroundControl geofence polygon.
\n \n - \n
Autonomous & Adaptive Missions: Arms, runs, and disarms the ASV automatically, adapting routes in real time based on sensor data.
\n \n - \n
Supported Sensors: Works with Ping1D, GPS, and more (fully configurable in config.yaml).
\n \n - \n
Persistent Data Logging: Stores mission logs and collected data as HDF5 files for post-mission analysis and map reconstruction.
\n \n - \n
Onboard Visualization: Easily publish mission results for real-time or offline viewing in Foxglove or Jupyter Notebook.
\n \n - \n
Easy Plan Upload: Drag and drop QGroundControl plan files with geofence directly into
\n/usr/blueos/extensions/sgptools. \n - \n
Web Terminal Access: Launch, debug, and analyze missions through the BlueOS browser UI.
\n \n - \n
Configurable & Extensible: Quickly modify sensors, mission types, and planner options via YAML config\u2014add new models with ease.
\n \n - \n
Integrated Simulator: Test, develop, and validate survey missions in a realistic Gazebo & SITL environment using our dedicated simulator docker container.
\n \n - \n
Minimal Setup: Installs in seconds from the BlueOS App Store; no complex setup required.
\n \n - \n
Multi-Arch & Platform Support: Runs on ARM64 (Raspberry Pi), AMD64, and any ArduPilot-compatible ASV with sufficient memory (4GB+). |
\n \n
\ud83d\udccb Prerequisites
\n- \n
- 64-bit BlueOS running on Raspberry Pi 4 or similar (ARM64) or AMD64 platform \n
- At least 4GB RAM + swap (see Swap Setup below) \n
- Compatible sensors (e.g., Ping1D sonar) \n
\ud83e\uddf0 Installation
\nInstall Directly from the BlueOS App Store
\n- \n
- Open BlueOS in your browser (e.g.,
http://blueos.local/) \n - Go to Extensions tab \n
- Find SGP-Tools in the App Store and click Install \n
- The extension will auto-launch on boot \n
\u2699\ufe0f Usage
\nUpload Your Survey Area Plan
\n- \n
- Use QGroundControl to draw your geofence and home position \n
- \n
Save as
mission.plan\n\n\n\n\n \n - \n
Upload to
/usr/blueos/extensions/sgptools/in BlueOS (usingFile BrowserinPirate Mode)\n\n\n\n\n \n
Configure (Optional)
\n- \n
- \n
Advanced users can edit
\n/root/config.yamlin the SGP-Tools web terminal to:- \n
- Select/modify sensor config \n
- Change mission type (
AdaptiveIPP,IPP,Waypoint) \n - Adjust optimization parameters \n
See the ros_sgp_tools README for configuration details.
\n \n
Start Your Mission
\n- \n
- Open the SGP-Tools web terminal from the BlueOS UI (left menu) \n
- \n
Start the planner:\n
\nros2 launch ros_sgp_tools asv.launch.py- \n
- The vehicle will arm, start the survey, and collect data automatically \n
\n\n\n\n \n
Data Visualization
\n- \n
- After the mission, you can visualize collected data via:\n
ros2 launch ros_sgp_tools visualize_data.launch.py\n - \n
Then open Foxglove in your browser, and connect to your ASV\u2019s IP to view the bathymetry data
\n \n - \n
\u26a0\ufe0f Do not run this during the mission, as it will disrupt the path planner
\n\n\n\n\n \n
\ud83d\udcbe Persistent Storage
\nThe extension maps:
\n- \n
- Host:
/usr/blueos/extensions/sgptools/\n - Container:
/root/ros2_ws/src/ros_sgp_tools/launch/data/\n
This directory is persistent and stores:
\n- \n
mission.plan\nconfig.yaml\n- All mission logs:
IPP-mission-<timestamp>/\n - Swap configuration script:
config_swap.sh\n
\ud83e\udde0 Swap Setup & Memory Requirements
\n- \n
- At least 4GB of RAM or swap is required. \n
- The extension includes a swap configuration script:\n
/usr/blueos/extensions/sgptools/config_swap.sh\n - \n
Increase swap (if needed):
\n- \n
- In BlueOS, open a terminal (Pirate Mode), then run: \n
\nbash\nred-pill
\nbash\nsudo bash /usr/blueos/extensions/sgptools/config_swap.sh\n
\ud83e\uddea Simulation & Testing with the SGP-Tools Simulator
\nWant to experiment, develop, or validate missions before deploying to the water?
\nThe docker-sgp-tools repository includes a fully integrated Gazebo simulator container with all the tools you need for realistic software-in-the-loop (SITL) testing.
\n\ud83d\ude80 Simulator Features
\n- \n
- \n
Gazebo Simulation: Realistic 3D environment with the BlueBoat ASV model and waves.
\n \n - \n
ArduPilot SITL: Software-in-the-loop autopilot runs your real survey missions.
\n \n - \n
SGP-Tools & ROS 2: The full path planning stack, exactly as on your robot.
\n \n
\ud83d\udcdd Notes and Troubleshooting
\n- \n
- \n
Extension won\u2019t launch / out of memory:
\nRun the swap setup, and ensure enough memory is available.
\n \n - \n
No mission data or logs:
\nMake sure the
\nPing 1Dport is correctly listed in theconfig.yaml\n - \n
Cannot connect via Foxglove:
\nVerify network settings, and that Foxglove bridge is running.
\n \n
\ud83d\udcda More Info & Documentation
\n- \n
- SGP-Tools project site \n
- ros_sgp_tools package \n
- SGP-Tools Docker images \n
- QGroundControl plan files \n
- BlueOS Docs \n
\u26a0\ufe0f Disclaimer
\nThis extension, when executed properly, will take control of the ASV and could potentially collide the vehicle with obstacles in the environment. Please use it with caution.
", "support": null, "requirements": null, "company": { "about": "", "name": "ItsKalvik", "email": "itskalvik@gmail.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Binds": [ "/dev:/dev:rw", "/usr/blueos/extensions/sgptools/:/root/ros2_ws/src/ros_sgp_tools/launch/data/:rw" ], "Privileged": true, "NetworkMode": "host" }, "Env": [ "DATA_FOLDER=/root/ros2_ws/src/ros_sgp_tools/launch/data/", "FCU_URL=tcp://0.0.0.0:5777@", "ROS_LOG_DIR=/root/ros2_ws/src/ros_sgp_tools/launch/data/logs/", "RCUTILS_COLORIZED_OUTPUT=1" ] } }, "0.0.1": { "identifier": "27f5395f-c846-5e5b-b18f-6eae933041aa", "type": "other", "website": null, "images": [ { "expanded_size": 1219010296, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:bab53082c7bb4fb0eadd51ed365b49b09ce2cb3309252742daf3b14a35e20240" }, { "expanded_size": 1661281637, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:57db6d238f6520a4a3738162ba8bfc4566e1f2ecbe78ee4b25c70fea279c9b0a" } ], "authors": [ { "name": "Kalvik Jakkala", "email": "itskalvik@gmail.com" } ], "filter_tags": [ "ros2", "robot" ], "extra_links": {}, "tag": "0.0.1", "docs": null, "readme": "A BlueOS extension that enables fully autonomous and adaptive bathymetric surveys on the BlueBoat and any ArduPilot-based ASV using SGP-Tools. Powered by the latest research in Informative Path Planning (IPP).
\n\ud83c\udf1f Features
\n- \n
- \n
Automatic Waypoint Generation: Generates efficient survey routes from your QGroundControl geofence polygon.
\n \n - \n
Autonomous & Adaptive Missions: Arms, runs, and disarms the ASV automatically, adapting routes in real time based on sensor data.
\n \n - \n
Supported Sensors: Works with Ping1D, GPS, and more (fully configurable in config.yaml).
\n \n - \n
Persistent Data Logging: Stores mission logs and collected data as HDF5 files for post-mission analysis and map reconstruction.
\n \n - \n
Onboard Visualization: Easily publish mission results for real-time or offline viewing in Foxglove or Jupyter Notebook.
\n \n - \n
Easy Plan Upload: Drag and drop QGroundControl plan files with geofence directly into
\n/usr/blueos/extensions/sgptools. \n - \n
Web Terminal Access: Launch, debug, and analyze missions through the BlueOS browser UI.
\n \n - \n
Configurable & Extensible: Quickly modify sensors, mission types, and planner options via YAML config\u2014add new models with ease.
\n \n - \n
Integrated Simulator: Test, develop, and validate survey missions in a realistic Gazebo & SITL environment using our dedicated simulator docker container.
\n \n - \n
Minimal Setup: Installs in seconds from the BlueOS App Store; no complex setup required.
\n \n - \n
Multi-Arch & Platform Support: Runs on ARM64 (Raspberry Pi), AMD64, and any ArduPilot-compatible ASV with sufficient memory (4GB+). |
\n \n
\ud83d\udccb Prerequisites
\n- \n
- 64-bit BlueOS running on Raspberry Pi 4 or similar (ARM64) or AMD64 platform \n
- At least 4GB RAM + swap (see Swap Setup below) \n
- Compatible sensors (e.g., Ping1D sonar) \n
\ud83e\uddf0 Installation
\nInstall Directly from the BlueOS App Store
\n- \n
- Open BlueOS in your browser (e.g.,
http://blueos.local/) \n - Go to Extensions tab \n
- Find SGP-Tools in the App Store and click Install \n
- The extension will auto-launch on boot \n
\u2699\ufe0f Usage
\nUpload Your Survey Area Plan
\n- \n
- Use QGroundControl to draw your geofence and home position \n
- \n
Save as
mission.plan\n\n\n\n\n \n - \n
Upload to
/usr/blueos/extensions/sgptools/in BlueOS (usingFile BrowserinPirate Mode)\n\n\n\n\n \n
Configure (Optional)
\n- \n
- \n
Advanced users can edit
\n/root/config.yamlin the SGP-Tools web terminal to:- \n
- Select/modify sensor config \n
- Change mission type (
AdaptiveIPP,IPP,Waypoint) \n - Adjust optimization parameters \n
See the ros_sgp_tools README for configuration details.
\n \n
Start Your Mission
\n- \n
- Open the SGP-Tools web terminal from the BlueOS UI (left menu) \n
- \n
Start the planner:\n
\nros2 launch ros_sgp_tools asv.launch.py- \n
- The vehicle will arm, start the survey, and collect data automatically \n
\n\n\n\n \n
Data Visualization
\n- \n
- After the mission, you can visualize collected data via:\n
ros2 launch ros_sgp_tools visualize_data.launch.py\n - \n
Then open Foxglove in your browser, and connect to your ASV\u2019s IP to view the bathymetry data
\n \n - \n
\u26a0\ufe0f Do not run this during the mission, as it will disrupt the path planner
\n\n\n\n\n \n
\ud83d\udcbe Persistent Storage
\nThe extension maps:
\n- \n
- Host:
/usr/blueos/extensions/sgptools/\n - Container:
/root/ros2_ws/src/ros_sgp_tools/launch/data/\n
This directory is persistent and stores:
\n- \n
mission.plan\nconfig.yaml\n- All mission logs:
IPP-mission-<timestamp>/\n - Swap configuration script:
config_swap.sh\n
\ud83e\udde0 Swap Setup & Memory Requirements
\n- \n
- At least 4GB of RAM or swap is required. \n
- The extension includes a swap configuration script:\n
/usr/blueos/extensions/sgptools/config_swap.sh\n - \n
Increase swap (if needed):
\n- \n
- In BlueOS, open a terminal (Pirate Mode), then run: \n
\nbash\nred-pill
\nbash\nsudo bash /usr/blueos/extensions/sgptools/config_swap.sh\n
\ud83e\uddea Simulation & Testing with the SGP-Tools Simulator
\nWant to experiment, develop, or validate missions before deploying to the water?
\nThe docker-sgp-tools repository includes a fully integrated Gazebo simulator container with all the tools you need for realistic software-in-the-loop (SITL) testing.
\n\ud83d\ude80 Simulator Features
\n- \n
- \n
Gazebo Simulation: Realistic 3D environment with the BlueBoat ASV model and waves.
\n \n - \n
ArduPilot SITL: Software-in-the-loop autopilot runs your real survey missions.
\n \n - \n
SGP-Tools & ROS 2: The full path planning stack, exactly as on your robot.
\n \n
\ud83d\udcdd Notes and Troubleshooting
\n- \n
- \n
Extension won\u2019t launch / out of memory:
\nRun the swap setup, and ensure enough memory is available.
\n \n - \n
No mission data or logs:
\nMake sure the
\nPing 1Dport is correctly listed in theconfig.yaml\n - \n
Cannot connect via Foxglove:
\nVerify network settings, and that Foxglove bridge is running.
\n \n
\ud83d\udcda More Info & Documentation
\n- \n
- SGP-Tools project site \n
- ros_sgp_tools package \n
- SGP-Tools Docker images \n
- QGroundControl plan files \n
- BlueOS Docs \n
\u26a0\ufe0f Disclaimer
\nThis extension, when executed properly, will take control of the ASV and could potentially collide the vehicle with obstacles in the environment. Please use it with caution.
", "support": null, "requirements": null, "company": { "about": "", "name": "ItsKalvik", "email": "itskalvik@gmail.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Binds": [ "/dev:/dev:rw", "/usr/blueos/extensions/sgptools/:/home/ros2_ws/src/ros_sgp_tools/launch/data/:rw" ], "Privileged": true, "NetworkMode": "host" }, "Env": [ "NAMESPACE=robot_0", "DATA_TYPE=Ping1D", "NUM_WAYPOINTS=20", "SAMPLING_RATE=2", "DATA_BUFFER_SIZE=200", "TRAIN_PARAM_INDUCING=False", "NUM_PARAM_INDUCING=40", "ADAPTIVE_IPP=True", "DATA_FOLDER=/home/ros2_ws/src/ros_sgp_tools/launch/data/", "FCU_URL=tcp://0.0.0.0:5777@", "PING1D_PORT=/dev/ttyUSB0", "KERNEL=RBF", "ROS_LOG_DIR=/home/ros2_ws/src/ros_sgp_tools/launch/data/logs/" ] } } }, "repo_info": { "downloads": 7025, "last_updated": "2026-01-12T19:56:58.274732Z", "date_registered": "2024-07-10T16:09:03.945501Z" } }, { "identifier": "vshie.pingSurvey", "name": "Simple Ping2 Survey", "website": "https://github.com/vshie/pingSurvey", "docker": "vshie/blueos-simplepingsurvey", "description": "Simple Ping2 Survey", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/vshie/pingSurvey/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/vshie/company_logo.png", "versions": { "v1.2.0": { "identifier": "a74a2595-5f47-5b01-9368-98691f545277", "type": "tool", "website": null, "images": [ { "expanded_size": 53317150, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:672bee7b87fd70b416ba65609830213417e6fcd75675d2fa49800359832b4701" }, { "expanded_size": 59063304, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:a98ed6a49113cfdaebf764b0d888e74b2e764049ea08a0e114eb0e66c0fabff8" } ], "authors": [ { "name": "Tony White", "email": "tonywhite@bluerobotics.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/vshie/pingSurvey" }, "tag": "v1.2.0", "docs": null, "readme": "BlueOS Ping Survey Extension
\nA simple extension for BlueOS that enables time-synchronized collection of sonar data from the Ping sonar, alongside GPS data. This extension provides both a full interface and a compact widget view for monitoring and recording survey data.
\nFeatures
\n- \n
- Real-time sonar depth and confidence monitoring \n
- GPS position tracking \n
- Vessel heading display \n
- Data logging at 2Hz \n
- CSV data export \n
- Compact widget view for Cockpit integration \n
- Automatic system ID detection \n
- Support for multiple autopilot types (ArduPilot, PX4, Generic) \n
Installation
\n- \n
- Install the extension through the BlueOS extension manager \n
- Follow the guide here: https://bluerobotics.com/learn/collecting-creating-bathymetry-blueboat-ping2/ \n
Usage
\nFull Interface
\nAccess the full interface by navigating to the menu entry in BlueOS for Simple Ping Survey
\nCockpit Widget Integration
\nTo add the compact widget to your Cockpit interface:
\n- \n
- Open Cockpit's edit interface \n
- Add a new iframe widget \n
- Set the iframe URL to:\n
http://\"your.vehicle.ip\"/extension/simpleping2survey/widget?full_page=true\n
Data Collection
\n- \n
- Click the play button to start data collection \n
- The extension will automatically detect the correct system ID and begin logging \n
- Data is saved to a CSV file with timestamps \n
- Use the download button to retrieve the collected data \n
Data Format
\nThe CSV file includes:\n- Unix Timestamp\n- Date\n- Time\n- Depth (cm)\n- Confidence (%)\n- Vessel heading (degrees)\n- Latitude\n- Longitude
\nSimulation Mode
\nYou can test the interface without connecting to real hardware by using the simulation mode:
\n- \n
- Create a file called
simulation.csvin the/app/logs/directory \n - Format it with the same columns as the regular data export (see Data Format section) \n
- Click the \"Start Simulation\" button in the interface \n
- The interface will play back the data from your CSV file at 5x real-time speed \n
This is useful for:\n- Testing the interface without hardware\n- Reviewing past survey data in the map view\n- Demonstrating the tool's capabilities\n- Development and testing\n- Quickly visualizing large datasets (5x speed playback)
\nTo create a simulation file from a previous survey, simply rename a downloaded data file to simulation.csv and place it in the logs directory.
Future Features
\n- \n
- Fix bar at top that scrolls down to hide \n
- WP Survey speed parameter control on page \n
- User controlled confidence filter on live and/or logged data \n
- Better mobile experience - scaling corner logos \n
Discussion
\nFor more information and updates, visit the Blue Robotics discussion thread
", "support": null, "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "5420/tcp": {} }, "HostConfig": { "Binds": [ "/usr/blueos/extensions/ping-survey:/app/logs" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "5420/tcp": [ { "HostPort": "" } ] } } } }, "v1.1.0": { "identifier": "680983f6-4985-5ae2-8a03-da915f553ec0", "type": "tool", "website": null, "images": [ { "expanded_size": 53883372, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:19244603abc98ed2d65404c9495a7ea1b567ac964a283b67dd19b05f36692702" } ], "authors": [ { "name": "Tony White", "email": "tonywhite@bluerobotics.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/vshie/pingSurvey" }, "tag": "v1.1.0", "docs": null, "readme": "BlueOS Ping Survey Extension
\nA simple extension for BlueOS that enables time-synchronized collection of sonar data from the Ping sonar, alongside GPS data. This extension provides both a full interface and a compact widget view for monitoring and recording survey data.
\nFeatures
\n- \n
- Real-time sonar depth and confidence monitoring \n
- GPS position tracking \n
- Vessel heading display \n
- Data logging at 2Hz \n
- CSV data export \n
- Compact widget view for Cockpit integration \n
- Automatic system ID detection \n
- Support for multiple autopilot types (ArduPilot, PX4, Generic) \n
Installation
\n- \n
- Install the extension through the BlueOS extension manager \n
- Follow the guide here: https://bluerobotics.com/learn/collecting-creating-bathymetry-blueboat-ping2/ \n
Usage
\nFull Interface
\nAccess the full interface by navigating to the menu entry in BlueOS for Simple Ping Survey
\nCockpit Widget Integration
\nTo add the compact widget to your Cockpit interface:
\n- \n
- Open Cockpit's edit interface \n
- Add a new iframe widget \n
- Set the iframe URL to:\n
http://\"your.vehicle.ip\"/extension/simpleping2survey/widget?full_page=true\n
Data Collection
\n- \n
- Click the play button to start data collection \n
- The extension will automatically detect the correct system ID and begin logging \n
- Data is saved to a CSV file with timestamps \n
- Use the download button to retrieve the collected data \n
Data Format
\nThe CSV file includes:\n- Unix Timestamp\n- Date\n- Time\n- Depth (cm)\n- Confidence (%)\n- Vessel heading (degrees)\n- Latitude\n- Longitude
\nSimulation Mode
\nYou can test the interface without connecting to real hardware by using the simulation mode:
\n- \n
- Create a file called
simulation.csvin the/app/logs/directory \n - Format it with the same columns as the regular data export (see Data Format section) \n
- Click the \"Start Simulation\" button in the interface \n
- The interface will play back the data from your CSV file at 5x real-time speed \n
This is useful for:\n- Testing the interface without hardware\n- Reviewing past survey data in the map view\n- Demonstrating the tool's capabilities\n- Development and testing\n- Quickly visualizing large datasets (5x speed playback)
\nTo create a simulation file from a previous survey, simply rename a downloaded data file to simulation.csv and place it in the logs directory.
Future Features
\n- \n
- Fix bar at top that scrolls down to hide \n
- WP Survey speed parameter control on page \n
- User controlled confidence filter on live and/or logged data \n
- Better mobile experience - scaling corner logos \n
Discussion
\nFor more information and updates, visit the Blue Robotics discussion thread
", "support": null, "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "5420/tcp": {} }, "HostConfig": { "Binds": [ "/usr/blueos/extensions/ping-survey:/app/logs" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "5420/tcp": [ { "HostPort": "" } ] } } } }, "v1.0.1": { "identifier": "91e2c1c5-9f3e-53aa-85a5-350c42bbe7f0", "type": "tool", "website": null, "images": [ { "expanded_size": 54415457, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:2917a429dfc66a447295883b8de1ca551ff3e64109bd6bdcf8d943d535811ac7" } ], "authors": [ { "name": "Tony White", "email": "tonywhite@bluerobotics.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/vshie/pingSurvey" }, "tag": "v1.0.1", "docs": null, "readme": "BlueOS-ping Survey
\nA simple extension for BlueOS intended for collection of time-sync'd sonar and GPS data.
\nRead more about this extension here
\nFuture feature ideas:
\n- \n
- Fix bar at top that scrolls down to hide \n
- WP Survey speed parameter control on page? \n
- User controlled confidence filter on live and/or logged data? \n
- Show GPS speed over ground in table, HDOP \n
- User configurable color gradient to depth mapping \n
- Better mobile experience - scaling corner logos \n
BlueOS-ping Survey
\nA simple extension for BlueOS intended for collection of time-sync'd sonar and GPS data.
\nFuture feature ideas:
", "support": null, "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "5420/tcp": {} }, "HostConfig": { "Binds": [ "/root/.config/blueos/extensions/$IMAGE_NAME:/root/.config" ], "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "5420/tcp": [ { "HostPort": "" } ] } } } } }, "repo_info": { "downloads": 12139, "last_updated": "2026-02-26T22:30:07.570846Z", "date_registered": "2023-10-04T23:07:17.135228Z" } }, { "identifier": "patrickelectric.starlink-position", "name": "Starlink Position", "website": "https://github.com/patrickelectric/blueos-starlink-position", "docker": "patrickelectric/blueos-starlink-position", "description": "Vehicle position system using starlink antenna", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/patrickelectric/starlink-position/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/patrickelectric/company_logo.png", "versions": { "1.0.4": { "identifier": "e618f598-9beb-5290-ad93-0f553fb283a4", "type": "tool", "website": null, "images": [ { "expanded_size": 179259870, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:2cf81a7225d871ae40dc6a4d01ac0f7c61b80927f1cdc4faf78c4932602f8a07" } ], "authors": [ { "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/patrickelectric/blueos-starlink-position" }, "tag": "1.0.4", "docs": null, "readme": "StarLink Position
\nA simple extension that publishes MAVLink data based on starlink position information
", "support": null, "requirements": "core >= 1.1", "company": { "about": "", "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host" } } }, "1.0.3": { "identifier": "216de75c-6672-58b6-984c-dd2cd87a2ac0", "type": "tool", "website": null, "images": [ { "expanded_size": 179259887, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:e1c600ba4baeb1f4c765a349e3145304c61b74da64b906c772a6c551c66b7339" } ], "authors": [ { "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/patrickelectric/blueos-starlink-position" }, "tag": "1.0.3", "docs": null, "readme": "StarLink Position
\nA simple extension that publishes MAVLink data based on starlink position information
", "support": null, "requirements": "core >= 1.1", "company": { "about": "", "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host" } } }, "1.0.2": { "identifier": "b656e161-26b7-5938-99eb-f382d42d397d", "type": "tool", "website": null, "images": [ { "expanded_size": 179258766, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:de0e17ea0fb9d9c25771472346c90d1343cf1181cd69cb2a0efd6c7bb9c1fbb4" } ], "authors": [ { "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/patrickelectric/blueos-starlink-position" }, "tag": "1.0.2", "docs": null, "readme": "StarLink Position
\nA simple extension that publishes MAVLink data based on starlink position information
", "support": null, "requirements": "core >= 1.1", "company": { "about": "", "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host" } } }, "1.0.1": { "identifier": "ff877584-305d-5b29-9307-c00188512ce5", "type": "tool", "website": null, "images": [ { "expanded_size": 179259372, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:337ece68c11acf4aacc92ea495dc217dfe00aed1b66e238f47a99d9ba1a6335d" } ], "authors": [ { "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/patrickelectric/blueos-starlink-position" }, "tag": "1.0.1", "docs": null, "readme": "StarLink Position
\nA simple extension that publishes MAVLink data based on starlink position information
", "support": null, "requirements": "core >= 1.1", "company": { "about": "", "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host" } } }, "1.0.0": { "identifier": "cfe9ae2f-4a0c-54ed-8dfe-9547e0535456", "type": "tool", "website": null, "images": [ { "expanded_size": 52783426, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:40a37f0c67fa7affdfb68a3e25e272105d6c1fd13d33a1bba63fd3198d6e94b8" } ], "authors": [ { "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": { "source": "https://github.com/patrickelectric/blueos-starlink-position" }, "tag": "1.0.0", "docs": null, "readme": "No README available", "support": null, "requirements": "core >= 1.1", "company": { "about": "", "name": "Patrick J. Pereira", "email": "patrickelectric@gmail.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host" } } } }, "repo_info": { "downloads": 9629, "last_updated": "2024-08-14T23:11:15.514761Z", "date_registered": "2024-08-07T21:20:39.693471Z" } }, { "identifier": "patrickelectric.mcm-cpu-analyzer", "name": "MCM CPU Analyzer", "website": "https://github.com/patrickelectric/blueos-mavlink-camera-manager-analyzer", "docker": "patrickelectric/blueos-mcm-analyzer", "description": "Analyzer for the MAVLink-Camera-Manager", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/patrickelectric/mcm-cpu-analyzer/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/patrickelectric/company_logo.png", "versions": { "0.0.4": { "identifier": "36e20a53-d708-5464-a87b-fc8d6e4778bb", "type": "tool", "website": "https://github.com/patrickelectric/blueos-mavlink-camera-manager-analyzer", "images": [ { "expanded_size": 54709030, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:26dc19fa1c27390cbb8480be6f9439c4a09dd76ecde30659e7a33a8984efff94" }, { "expanded_size": 57614727, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:3be36e64a7865ca3c0668af0aad34e2c30e44fea1e493ffc0411df46092787c6" }, { "expanded_size": 57823630, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:4bddfb14144eb06114e6a58255636a7420357e681155d334e766bfec761f2eba" } ], "authors": [ { "name": "Patrick Jose Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": {}, "tag": "0.0.4", "docs": null, "readme": "No README available", "support": "https://github.com/patrickelectric/blueos-mavlink-camera-manager-analyzer/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "3000/tcp": {} }, "HostConfig": { "Binds": [ "/var/run/docker.sock:/var/run/docker.sock" ], "PortBindings": { "3000/tcp": [ { "HostPort": "" } ] } } } }, "0.0.3": { "identifier": "3283d309-f65c-514b-9be2-a8a6743e257a", "type": "tool", "website": "https://github.com/patrickelectric/blueos-mavlink-camera-manager-analyzer", "images": [ { "expanded_size": 54709029, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:9742b19f92f3043044beeef061b58e1619323b503f009a458f1befa99fe3a585" }, { "expanded_size": 57614726, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:1095174c778c959bbbf09ed55c55651cd934ca07ddc36317c14565eed17a6418" }, { "expanded_size": 57823629, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:422f73a9e31c90a2cac13df4186eb96f9419ea8c07ba669a88a20a74b7766b71" } ], "authors": [ { "name": "Patrick Jose Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": {}, "tag": "0.0.3", "docs": null, "readme": "No README available", "support": "https://github.com/patrickelectric/blueos-mavlink-camera-manager-analyzer/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "3000/tcp": {} }, "HostConfig": { "Binds": [ "/var/run/docker.sock:/var/run/docker.sock" ], "PortBindings": { "3000/tcp": [ { "HostPort": "" } ] } } } }, "0.0.2": { "identifier": "d5f71846-74ba-5481-bcb2-592e9d26cf54", "type": "tool", "website": "https://github.com/patrickelectric/blueos-mavlink-camera-manager-analyzer", "images": [ { "expanded_size": 54708939, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:990fab394e2460cf6ac5f0141055bb25c10cef7d34d96fb4dfd59ba46e64376a" }, { "expanded_size": 57614637, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:c4ab8a17c94b3b37d1701954f4617494a568b05bbbd5ecec20e8dae743dffa53" }, { "expanded_size": 57823540, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:ca0e36aed5e840efcd472c2ac05de5b2aec1baaaab7650338710eb3bc033b606" } ], "authors": [ { "name": "Patrick Jose Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": {}, "tag": "0.0.2", "docs": null, "readme": "No README available", "support": "https://github.com/patrickelectric/blueos-mavlink-camera-manager-analyzer/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "3000/tcp": {} }, "HostConfig": { "Binds": [ "/var/run/docker.sock:/var/run/docker.sock" ], "PortBindings": { "3000/tcp": [ { "HostPort": "" } ] } } } }, "0.0.1": { "identifier": "37a430bc-2c26-50da-82fa-77c7ecf834e0", "type": "tool", "website": "https://github.com/patrickelectric/blueos-mavlink-camera-manager-analyzer", "images": [ { "expanded_size": 54708185, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:48b64bf5ee595b990f3900e65ecfad144710654e45e1fecfd19ddf0aa10482a4" }, { "expanded_size": 57613885, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:8d5330c481e4964c2d8fc923d64093f4e5b7da5c6c655e8a7dc897bfc1c43d4d" }, { "expanded_size": 57822785, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:b0b174d528248212a900f93622dba1ea6f67eb90c6f2c80bc94a67295a321dea" } ], "authors": [ { "name": "Patrick Jose Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [], "extra_links": {}, "tag": "0.0.1", "docs": null, "readme": "No README available", "support": "https://github.com/patrickelectric/blueos-mavlink-camera-manager-analyzer/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Blue Robotics", "email": "support@bluerobotics.com" }, "permissions": { "ExposedPorts": { "3000/tcp": {} }, "HostConfig": { "Binds": [ "/var/run/docker.sock:/var/run/docker.sock" ], "PortBindings": { "3000/tcp": [ { "HostPort": "" } ] } } } } }, "repo_info": { "downloads": 794, "last_updated": "2026-02-14T11:38:51.179098Z", "date_registered": "2026-02-13T23:36:10.488489Z" } }, { "identifier": "patrickelectric.foxglove", "name": "BlueOs Foxglove", "website": "https://github.com/patrickelectric/blueos-foxglove", "docker": "patrickelectric/blueos-foxglove", "description": "BlueOS extension that integrates zenoh data to foxglove studio", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/patrickelectric/foxglove/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/patrickelectric/company_logo.png", "versions": { "0.0.4": { "identifier": "5bbb5301-d70e-5b18-b3b1-753e1b7738a9", "type": "other", "website": null, "images": [ { "expanded_size": 81194798, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:3f0def33deec7c0356df93c736d1b2928f927b1c28f85e13caafdcf77fbe1c92" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "zenoh", "foxglove", "mavlink" ], "extra_links": {}, "tag": "0.0.4", "docs": null, "readme": "BlueOS-foxglove
", "support": null, "requirements": null, "company": { "about": "", "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host" } } }, "0.0.3": { "identifier": "2c35721b-07d2-53df-bad1-78f239c9f55a", "type": "other", "website": null, "images": [ { "expanded_size": 80536736, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:e17775d0de8b6f06cc14357d7e66a952e3a95181989bdf7f9303ace06a3ab07d" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "zenoh", "foxglove", "mavlink" ], "extra_links": {}, "tag": "0.0.3", "docs": null, "readme": "BlueOS-foxglove
", "support": null, "requirements": null, "company": { "about": "", "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host" } } }, "0.0.2": { "identifier": "721a73ea-07ea-5cf0-a415-7ceeaf8dcdda", "type": "other", "website": null, "images": [ { "expanded_size": 78831119, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:4e55b7c994082aa0a5748e0ab0b8e643e22a1ec7df53831fccb8dbf35a22dac8" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "zenoh", "foxglove", "mavlink" ], "extra_links": {}, "tag": "0.0.2", "docs": null, "readme": "BlueOS-foxglove
", "support": null, "requirements": null, "company": { "about": "", "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host" } } }, "0.0.1": { "identifier": "f366ae76-4849-53d9-9017-c08a19dd7700", "type": "other", "website": null, "images": [ { "expanded_size": 78739648, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:a282434f9bc77ba76ec462a398b252e215a622b48a1d3c64640ce5a596861565" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "zenoh", "foxglove", "mavlink" ], "extra_links": {}, "tag": "0.0.1", "docs": null, "readme": "BlueOS-foxglove
", "support": null, "requirements": null, "company": { "about": "", "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host" } } }, "0.0.0": { "identifier": "523ad81d-118d-51aa-b28a-c85abe425b82", "type": "other", "website": null, "images": [ { "expanded_size": 80107116, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:bdd8ce9854a25c446c2ce6196422d0d073172d8c3bda3ab514cf7af6247b0818" } ], "authors": [ { "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" } ], "filter_tags": [ "zenoh", "foxglove", "mavlink" ], "extra_links": {}, "tag": "0.0.0", "docs": null, "readme": "BlueOS-foxglove
", "support": null, "requirements": null, "company": { "about": "", "name": "Patrick Jos\u00e9 Pereira", "email": "patrickelectric@gmail.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Privileged": true, "NetworkMode": "host" } } } }, "repo_info": { "downloads": 5679, "last_updated": "2025-07-02T21:21:55.372997Z", "date_registered": "2025-05-15T18:03:05.507931Z" } }, { "identifier": "clydemcqueen.surftrak_fixit", "name": "Surftrak Fixit", "website": "https://github.com/clydemcqueen/surftrak_fixit", "docker": "clydemcqueen/surftrak_fixit", "description": "Find and fix common Surftrak problems", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/clydemcqueen/surftrak_fixit/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/clydemcqueen/company_logo.png", "versions": { "v1.0.0-beta.2": { "identifier": "4ecee07e-b90d-5881-b8a1-2e8c8cb188ce", "type": "tool", "website": "https://github.com/clydemcqueen/surftrak_fixit", "images": [ { "expanded_size": 365331591, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:98fbd29fe82059d0314a82aade3c29192f7d612594ab40887823b400b7867f7c" }, { "expanded_size": 331368598, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:7974dbabcfbe92c237617c431b666fc24732cf9fd3c5423f069ec752c20aa827" } ], "authors": [ { "name": "Clyde McQueen", "email": "clyde@mcqueen.net" } ], "filter_tags": [ "surftrak" ], "extra_links": {}, "tag": "v1.0.0-beta.2", "docs": null, "readme": "Surftrak Fixit
\nSurftrak is a new flight mode in ArduSub 4.5.
\nSurftrak Fixit is a BlueOS extension that can diagnose and fix Surftrak problems.
\nInstall
\n- \n
- Select Extensions in the sidebar \n
- Click on Surftrak Fixit \n
- Click Install \n
Releases
\nv1.0.0-beta.2
\n- \n
- Display DISTANCE_SENSOR messages from well-known sources \n
- Check for bad RNGFND1_TYPE \n
- Add FIX IT buttons for some problems \n
- UI improvements, works in dark mode \n
v1.0.0-beta.1
\n- \n
- First version \n
Developer Notes
\nInstall a custom version
\n- \n
- Select Extensions in the sidebar, then the Installed tab \n
- Click on the + icon in the lower right \n
- Enter the following information, modifying as necessary \n
- Click Create \n
Extension Identifier\n~~~\nclydemcqueen.surftrak_fixit\n~~~
\nExtension Name\n~~~\nsurftrak_fixit\n~~~
\nDocker image\n~~~\nclydemcqueen/surftrak_fixit\n~~~
\nDocker tag\n~~~\nv1.0.0-beta.2\n~~~
\nCustom settings\n~~~\n{\n \"ExposedPorts\": {\n \"8080/tcp\": {}\n },\n \"HostConfig\": {\n \"ExtraHosts\": [\"host.docker.internal:host-gateway\"],\n \"PortBindings\": {\n \"8080/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n }\n },\n \"Env\": [\"MAVLINK2REST_URL=http://host.docker.internal/mavlink2rest/v1\"]\n}\n~~~
\nTesting with ArduSub SITL
\nSurftrak Fixit looks only at MAVLink messages, so it can be tested against ArduSub SITL and\nmavlink2rest.
\nSee these instructions to set up ArduSub SITL.
\nTerminal 1: run SITL\n~~~\ncd $ARDUPILOT_HOME\nmkdir run_sim\ncd run_sim\nnice ../Tools/autotest/sim_vehicle.py -G -D -l 47.6302,-122.3982391,-0.1,270 -v Sub -f vectored --out \"127.0.0.1:14551\"\n~~~
\nTerminal 2: run mavlink2rest in a docker container\n~~~\ndocker build --build-arg TARGET_ARCH=x86_64-unknown-linux-musl -t mavlink/mavlink2rest .\ndocker run --rm --init -p 8088:8088 -p 14550:14550/udp --name mavlink2rest mavlink/mavlink2rest\n~~~
\nTerminal 3: run Surftrak Fixit\n~~~\n./main.py --mavlink2rest_url http://localhost:8088/v1\n~~~
\nTerminal 4: emulate a MAVLink rangefinder\n~~~\n./fake_rf.py --ping\n~~~
\nYou can see the extension UI at http://localhost:8080/
", "support": "https://github.com/clydemcqueen/surftrak_fixit/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Discovery Bay", "email": "clyde@mcqueen.net" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } }, "Env": [ "MAVLINK2REST_URL=http://host.docker.internal/mavlink2rest/v1" ] } }, "v1.0.0-beta.1": { "identifier": "284c6155-4ffc-50aa-98dd-c7eae198eac5", "type": "tool", "website": "https://github.com/clydemcqueen/surftrak_fixit", "images": [ { "expanded_size": 354149671, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:92de85e3559f394ef9f96f4def2c6856099ba7d637a6864b9b1f505216230b6a" }, { "expanded_size": 313220600, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:9cf0c02c92ef84c1964878116dd349fb923c0e220abb7a0a86583e6672213b73" } ], "authors": [ { "name": "Clyde McQueen", "email": "clyde@mcqueen.net" } ], "filter_tags": [ "surftrak" ], "extra_links": {}, "tag": "v1.0.0-beta.1", "docs": null, "readme": "Surftrak Fixit
\nSurftrak is a new flight mode in ArduSub 4.5.
\nSurftrak Fixit is a BlueOS\nextension that can diagnose and suggest fixes for some common Surftrak problems.
\nInstall
\nTo install this extension in BlueOS:\n* Select Extensions in the sidebar, then the Installed tab\n* Click on the + icon in the lower right\n* Enter the following information, then click Create
\nExtension Identifier\n~~~\nclydemcqueen.surftrak_fixit\n~~~
\nExtension Name\n~~~\nsurftrak_fixit\n~~~
\nDocker image\n~~~\nclydemcqueen/surftrak_fixit\n~~~
\nDocker tag\n~~~\nv1.0.0-beta.1\n~~~
\nCustom settings\n~~~\n{\n \"ExposedPorts\": {\n \"8080/tcp\": {}\n },\n \"HostConfig\": {\n \"ExtraHosts\": [\"host.docker.internal:host-gateway\"],\n \"PortBindings\": {\n \"8080/tcp\": [\n {\n \"HostPort\": \"\"\n }\n ]\n }\n },\n \"Env\": [\"MAVLINK2REST_URL=http://host.docker.internal/mavlink2rest/v1\"]\n}\n~~~
", "support": "https://github.com/clydemcqueen/surftrak_fixit/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Discovery Bay", "email": "clyde@mcqueen.net" }, "permissions": { "ExposedPorts": { "8080/tcp": {} }, "HostConfig": { "ExtraHosts": [ "host.docker.internal:host-gateway" ], "PortBindings": { "8080/tcp": [ { "HostPort": "" } ] } }, "Env": [ "MAVLINK2REST_URL=http://host.docker.internal/mavlink2rest/v1" ] } } }, "repo_info": { "downloads": 5320, "last_updated": "2024-06-23T16:01:49.148109Z", "date_registered": "2024-06-08T17:31:16.936347Z" } }, { "identifier": "clydemcqueen.wl_ugps_external", "name": "WL UGPS External", "website": "https://github.com/clydemcqueen/wl_ugps_external_extension", "docker": "clydemcqueen/wl_ugps_external_extension", "description": "Send GNSS compass data to WL UGPS", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/clydemcqueen/wl_ugps_external/extension_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/clydemcqueen/company_logo.png", "versions": { "v1.1.0-beta.1": { "identifier": "37d18a9b-b24e-5389-914c-13f4e04a48d4", "type": "device-integration", "website": "https://github.com/clydemcqueen/wl_ugps_external_extension", "images": [ { "expanded_size": 59536302, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:1121dff230845ca93bb54ac543a3290d59dc639f7e796725143f2042d08c7127" }, { "expanded_size": 53131138, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:cd6803b56aeea2f0db28c744b3ca92a5325c7f27d367d3d348ec585926bfd3f1" } ], "authors": [ { "name": "Clyde McQueen", "email": "clyde@mcqueen.net" } ], "filter_tags": [ "positioning", "navigation", "short-baseline" ], "extra_links": {}, "tag": "v1.1.0-beta.1", "docs": null, "readme": "WL UGPS External
\nSend NMEA position information (GGA and HDT) to the Water Linked UGPS API.
\nTypical Configuration
\nAdd a satellite compass to the topside vessel and connect it to the ROV Ethernet network.
\n- \n
- It should have a static IP address on the 192.168.2.X subnet \n
- It should send GGA and HDT messages via UDP to BlueOS at 192.168.2.2:6200 \n
Install this extension in BlueOS:
\n- \n
- Select Extensions in the sidebar \n
- Click on WL UGPS External \n
- Click Install \n
After a few moments you should see the WL UGPS External entry in the sidebar.\nClick on it to see a very simple UI.
\nArguments
\n- \n
- Set
UGPS_HOSTto the IP address of the WL UGPS G2 box. The default ishttp://192.168.2.94. \n - Set
SEND_RATEto the rate to send position information to the G2 box. The default is 2Hz. \n - Set
POLL_RATEto the rate to poll the G2 box for acoustic and pose information. The default is 0 (no polling). \n - If
LOG_NMEAis--log_nmea, then NMEA messages will be logged. The default is blank (no logging). \n
You can provide custom arguments in BlueOS. For example, you can enable logging using these arguments:\n~~~\n{\n \"Env\": [\n \"UGPS_HOST=http://192.168.2.94\",\n \"SEND_RATE=2.0\",\n \"POLL_RATE=5.0\",\n \"LOG_NMEA=--log_nmea\"\n ]\n}\n~~~
\nLogs can be found in BlueOS:
\n- \n
- Select File Browser in the sidebar \n
- Click on extensions \n
- Click on wl_ugps_external \n
Caveats
\n- \n
- The G2 box still needs a GPS fix to synchronize its clock. \n
Releases
\nv1.1.0-beta.1
\n- \n
- Optional: Log GGA, HDT and PASHR messages \n
- Optional: Poll the G2 box for additional information (pose, acoustic solution) and log the results \n
v1.0.3
\n- \n
- Shorten company name \n
- No user-visible changes \n
v1.0.2
\n- \n
- Update requirements.txt, setup.py \n
- No user-visible changes \n
v1.0.1
\n- \n
- Simplify README \n
v1.0.0
\n- \n
- Initial release \n
Developer notes
\nSee wl_ugps_external for testing tools.
", "support": "https://github.com/clydemcqueen/wl_ugps_external_extension/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Discovery Bay", "email": "clyde@mcqueen.net" }, "permissions": { "ExposedPorts": { "8080/tcp": {}, "6200:6200/udp": {} }, "HostConfig": { "Binds": [ "/usr/blueos/extensions/wl_ugps_external:/data:rw" ], "PortBindings": { "6200/udp": [ { "HostPort": "6200" } ], "8080/tcp": [ { "HostPort": "" } ] } }, "Env": [ "UGPS_HOST=http://192.168.2.94", "SEND_RATE=2.0", "POLL_RATE=0.0", "LOG_NMEA=" ] } }, "v1.0.3": { "identifier": "f62c3d5a-716d-5f9d-89f4-1f44cb29fcd2", "type": "device-integration", "website": "https://github.com/clydemcqueen/wl_ugps_external_extension", "images": [ { "expanded_size": 51589275, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:847790ac52cc419d9cf8206c685353c0de21e2cd935f38cf31d79c03ef450f9c" }, { "expanded_size": 45696701, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:2adff8e939478262b0cc0b35ee93d79f6a6d876902a10350e3ce93d7c7403dfe" } ], "authors": [ { "name": "Clyde McQueen", "email": "clyde@mcqueen.net" } ], "filter_tags": [ "positioning", "navigation", "short-baseline" ], "extra_links": {}, "tag": "v1.0.3", "docs": null, "readme": "WL UGPS External
\nSend NMEA position information (GGA and HDT) to the Water Linked UGPS API.
\nTypical Configuration
\nAdd a satellite compass to the topside vessel and connect it to the ROV Ethernet network.\n* It should have a static IP address on the 192.168.2.X subnet\n* It should send GGA and HDT messages via UDP to BlueOS at 192.168.2.2:6200
\nInstall this extension in BlueOS:\n* Select Extensions in the sidebar\n* Click on WL UGPS External\n* Click Install
\nAfter a few moments you should see the WL UGPS External entry in the sidebar.\nClick on it to see a very simple UI.
\nArguments
\n- \n
UGPS_HOSTis the IP address of the WL UGPS G2 box, the default ishttp://192.168.2.94\nSEND_RATEis the rate to send position information to the G2 box, the default is 2Hz \n
Caveats
\n- \n
- The G2 box still needs a GPS fix to synchronize its clock. \n
Releases
\nv1.0.3
\n- \n
- Shorten company name \n
- No user-visible changes \n
v1.0.2
\n- \n
- Update requirements.txt, setup.py \n
- No user-visible changes \n
v1.0.1
\n- \n
- Simplify README \n
v1.0.0
\n- \n
- Initial release \n
Developer notes
\nSee https://github.com/clydemcqueen/wl_ugps_external for testing tools.
", "support": "https://github.com/clydemcqueen/wl_ugps_external_extension/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Discovery Bay", "email": "clyde@mcqueen.net" }, "permissions": { "ExposedPorts": { "8080/tcp": {}, "6200:6200/udp": {} }, "HostConfig": { "PortBindings": { "6200/udp": [ { "HostPort": "6200" } ], "8080/tcp": [ { "HostPort": "" } ] } }, "Env": [ "UGPS_HOST=http://192.168.2.94", "SEND_RATE=2.0" ] } }, "v1.0.2": { "identifier": "feba0cfb-e968-5301-b11e-90b6071bd828", "type": "device-integration", "website": "https://github.com/clydemcqueen/wl_ugps_external_extension", "images": [ { "expanded_size": 45696653, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:54e2275c5e9ea7aef7df80d3ace428f9ef287e9cd249ca6a70c22108a0ebfe9f" }, { "expanded_size": 51589213, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:9c87f6fec45bd621c73a25f1af997075aa140d73c45600cf11982ffa26c72a90" } ], "authors": [ { "name": "Clyde McQueen", "email": "clyde@mcqueen.net" } ], "filter_tags": [ "positioning", "navigation", "short-baseline" ], "extra_links": {}, "tag": "v1.0.2", "docs": null, "readme": "WL UGPS External
\nSend NMEA position information (GGA and HDT) to the Water Linked UGPS API.
\nTypical Configuration
\nAdd a satellite compass to the topside vessel and connect it to the ROV Ethernet network.\n* It should have a static IP address on the 192.168.2.X subnet\n* It should send GGA and HDT messages via UDP to BlueOS at 192.168.2.2:6200
\nInstall this extension in BlueOS:\n* Select Extensions in the sidebar\n* Click on WL UGPS External\n* Click Install
\nAfter a few moments you should see the WL UGPS External entry in the sidebar.\nClick on it to see a very simple UI.
\nArguments
\n- \n
UGPS_HOSTis the IP address of the WL UGPS G2 box, the default ishttp://192.168.2.94\nSEND_RATEis the rate to send position information to the G2 box, the default is 2Hz \n
Caveats
\n- \n
- The G2 box still needs a GPS fix to synchronize its clock. \n
Releases
\nv1.0.2
\n- \n
- Update requirements.txt, setup.py \n
- No user-visible changes \n
v1.0.1
\n- \n
- Simplified README \n
v1.0.0
\n- \n
- Initial release \n
Developer notes
\nSee https://github.com/clydemcqueen/wl_ugps_external for testing tools.
", "support": "https://github.com/clydemcqueen/wl_ugps_external_extension/issues", "requirements": "core >= 1.1", "company": { "about": "", "name": "Discovery Bay Robotics", "email": "clyde@mcqueen.net" }, "permissions": { "ExposedPorts": { "8080/tcp": {}, "6200:6200/udp": {} }, "HostConfig": { "PortBindings": { "6200/udp": [ { "HostPort": "6200" } ], "8080/tcp": [ { "HostPort": "" } ] } }, "Env": [ "UGPS_HOST=http://192.168.2.94", "SEND_RATE=2.0" ] } }, "v1.0.1": { "identifier": "32a5efd4-9364-5021-a677-9c6371f90e29", "type": "device-integration", "website": "https://github.com/clydemcqueen/wl_ugps_external_extension", "images": [ { "expanded_size": 50224616, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:4341a15707d539c397b078a6e1817603d87fe1eb7f218a51a48c74bf9ea5f1b5" }, { "expanded_size": 44578751, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:e0fab510697080cd9c972e1eeb987371fc49f11d64384574a1c80fd72da5c3a6" } ], "authors": [ { "name": "Clyde McQueen", "email": "clyde@mcqueen.net" } ], "filter_tags": [ "positioning", "navigation", "short-baseline" ], "extra_links": {}, "tag": "v1.0.1", "docs": null, "readme": "WL UGPS External
\nSend NMEA position information (GGA and HDT) to the Water Linked UGPS API.
\nTypical Configuration
\nAdd a satellite compass to the topside vessel and connect it to the ROV Ethernet network.\n* It should have a static IP address on the 192.168.2.X subnet\n* It should send GGA and HDT messages via UDP to BlueOS at 192.168.2.2:6200
\nInstall this extension in BlueOS:\n* Select Extensions in the sidebar\n* Click on WL UGPS External\n* Click Install
\nAfter a few moments you should see the WL UGPS External entry in the sidebar.\nClick on it to see a very simple UI.
\nArguments
\n- \n
UGPS_HOSTis the IP address of the WL UGPS G2 box, the default ishttp://192.168.2.94\nSEND_RATEis the rate to send position information to the G2 box, the default is 2Hz \n
Caveats
\n- \n
- The G2 box still needs a GPS fix to synchronize its clock. \n
Releases
\nv1.0.1
\n- \n
- Simplified README \n
v1.0.0
\n- \n
- Initial release \n
BlueOS-Cerulean-DVL
\nCerulean DVL driver, compatible with Blue Robotics BlueOS.
\nManual Installation:
\nTo set this up, ssh into the Raspberry Pi (or access via red-pill in BlueOS Terminal) and run
sudo docker run -d --net=host -v /root/.config/cerulean:/root/.config --name=BlueOS-Cerulean-DVL --restart=unless-stopped nicknothom/blueos-cerulean-dvl:latest
The service will show in the \"Available Services\" section in BlueOS, where there are some configuration options.
", "support": "https://forum.ceruleansonar.com/categories", "requirements": null, "company": { "about": "", "name": "Cerulean Sonar", "email": "dennys.bisogno@ceruleansonar.com" }, "permissions": { "HostConfig": { "NetworkMode": "host", "Binds": [ "/root/.config/cerulean:/root/.config" ] } } }, "v1.0.7": { "identifier": "8f856745-ea5b-56a3-87fe-c893f0bf2a9a", "type": "other", "website": "https://ceruleansonar.com", "images": [ { "expanded_size": 100085651, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:cdc856ea07548d4cd6e2993ebd81baad2a018034b24085a13f71e6021ad969c5" } ], "authors": [ { "name": "Nick Nothom", "email": "nick.nothom@ceruleansonar.com" } ], "filter_tags": [], "extra_links": {}, "tag": "v1.0.7", "docs": "", "readme": "BlueOS-Cerulean-DVL
\nCerulean DVL driver, compatible with Blue Robotics BlueOS.
\nManual Installation:
\nTo set this up, ssh into the Raspberry Pi (or access via red-pill in BlueOS Terminal) and run
sudo docker run -d --net=host -v /root/.config/cerulean:/root/.config --name=BlueOS-Cerulean-DVL --restart=unless-stopped nicknothom/blueos-cerulean-dvl:latest
The service will show in the \"Available Services\" section in BlueOS, where there are some configuration options.
", "support": "https://forum.ceruleansonar.com/categories", "requirements": null, "company": { "about": "", "name": "Cerulean Sonar", "email": "dennys.bisogno@ceruleansonar.com" }, "permissions": { "HostConfig": { "NetworkMode": "host", "Binds": [ "/root/.config/cerulean:/root/.config" ] } } }, "v1.0.6": { "identifier": "b52186e9-c76e-5768-bf31-d34231668d0e", "type": "other", "website": "https://ceruleansonar.com", "images": [ { "expanded_size": 109617694, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:2638f474a73f2eb41bb1a5f237cd72eac2078d55cc3501d04c503bfa82cbe854" }, { "expanded_size": 100082275, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:452ef69b3fff8ccf2e2ecd47d431b1ae5c4244802c8df2e7ed59259ae3e084f6" } ], "authors": [ { "name": "Nick Nothom", "email": "nick.nothom@ceruleansonar.com" } ], "filter_tags": [], "extra_links": {}, "tag": "v1.0.6", "docs": "", "readme": "BlueOS-Cerulean-DVL
\nCerulean DVL driver, compatible with Blue Robotics BlueOS.
\nManual Installation:
\nTo set this up, ssh into the Raspberry Pi (or access via red-pill in BlueOS Terminal) and run
sudo docker run -d --net=host -v /root/.config/cerulean:/root/.config --name=BlueOS-Cerulean-DVL --restart=unless-stopped nicknothom/blueos-cerulean-dvl:latest
The service will show in the \"Available Services\" section in BlueOS, where there are some configuration options.
", "support": "https://forum.ceruleansonar.com/categories", "requirements": null, "company": { "about": "", "name": "Cerulean Sonar", "email": "dennys.bisogno@ceruleansonar.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Binds": [ "/root/.config/cerulean:/root/.config" ] } } }, "v1.0.5": { "identifier": "eb83e2bc-7f5a-5eb5-b5ab-95ca97364c27", "type": "other", "website": "https://ceruleansonar.com", "images": [ { "expanded_size": 100029465, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:b31f7996252e37ad56b7a84df851ced94adaf815b688abffeaa79c1f2bcfaa1f" } ], "authors": [ { "name": "Nick Nothom", "email": "nick.nothom@ceruleansonar.com" } ], "filter_tags": [], "extra_links": {}, "tag": "v1.0.5", "docs": "", "readme": "BlueOS-Cerulean-DVL
\nCerulean DVL driver, compatible with Blue Robotics BlueOS.
\nManual Installation:
\nTo set this up, ssh into the Raspberry Pi (or access via red-pill in BlueOS Terminal) and run
sudo docker run -d --net=host -v /root/.config/cerulean:/root/.config --name=BlueOS-Cerulean-DVL --restart=unless-stopped nicknothom/blueos-cerulean-dvl:latest
The service will show in the \"Available Services\" section in BlueOS, where there are some configuration options.
", "support": "https://forum.ceruleansonar.com/categories", "requirements": null, "company": { "about": "", "name": "Cerulean Sonar", "email": "dennys.bisogno@ceruleansonar.com" }, "permissions": { "NetworkMode": "host", "HostConfig": { "Binds": [ "/root/.config/blueos:/root/.config" ] } } }, "v1.0.4": { "identifier": "2056eda3-d739-511c-a708-054d2ef830c2", "type": "other", "website": "https://ceruleansonar.com", "images": [ { "expanded_size": 99947116, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:8c3edb7d465c05b9b735cc55291fa323deb95f3f11c086ecd47729f0d78a5249" } ], "authors": [ { "name": "Nick Nothom", "email": "nick.nothom@ceruleansonar.com" } ], "filter_tags": [], "extra_links": {}, "tag": "v1.0.4", "docs": "", "readme": "BlueOS-Cerulean-DVL
\nCerulean DVL driver, compatible with Blue Robotics BlueOS.
\nManual Installation:
\nTo set this up, ssh into the Raspberry Pi (or access via red-pill in BlueOS Terminal) and run
sudo docker run -d --net=host -v /root/.config/cerulean:/root/.config --name=BlueOS-Cerulean-DVL --restart=unless-stopped nicknothom/blueos-cerulean-dvl:latest
The service will show in the \"Available Services\" section in BlueOS, where there are some configuration options.
", "support": "https://forum.ceruleansonar.com/categories", "requirements": null, "company": { "about": "", "name": "Cerulean Sonar", "email": "dennys.bisogno@ceruleansonar.com" }, "permissions": { "NetworkMode": "host" } }, "v1.0.2": { "identifier": "57d15a76-04cd-515d-a297-58a4bb60088e", "type": "other", "website": "https://ceruleansonar.com", "images": [ { "expanded_size": 100174048, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:19f8215cae9fa37e89c9e8596ec2010d520430d46bf3fb93d58ed7f6e7745fac" } ], "authors": [ { "name": "Nick Nothom", "email": "nick.nothom@ceruleansonar.com" } ], "filter_tags": [], "extra_links": {}, "tag": "v1.0.2", "docs": "", "readme": "BlueOS-Cerulean-DVL
\nCerulean DVL driver, compatible with Blue Robotics BlueOS.
\nManual Installation:
\nTo set this up, ssh into the Raspberry Pi (or access via red-pill in BlueOS Terminal) and run
sudo docker run -d --net=host -v /root/.config/cerulean:/root/.config --name=BlueOS-Cerulean-DVL --restart=unless-stopped nicknothom/blueos-cerulean-dvl:latest
The service will show in the \"Available Services\" section in BlueOS, where there are some configuration options.
", "support": "https://forum.ceruleansonar.com/categories", "requirements": null, "company": { "about": "", "name": "Cerulean Sonar", "email": "dennys.bisogno@ceruleansonar.com" }, "permissions": { "NetworkMode": "host" } }, "v1.0.1": { "identifier": "5fda492f-72b4-54c0-bd0f-fca4761a0bfd", "type": "other", "website": "https://ceruleansonar.com", "images": [ { "expanded_size": 109912491, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:d5e8e487e02db3573da4b82b5c1bffcfd7dc56115aabc9e31d46b441205e8678" }, { "expanded_size": 100174019, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:11543c36b10be611293248778bc7b924eea38b7bfa47f39701c1b72d3b9a288f" } ], "authors": [ { "name": "Nick Nothom", "email": "nick.nothom@ceruleansonar.com" } ], "filter_tags": [], "extra_links": {}, "tag": "v1.0.1", "docs": "", "readme": "BlueOS-Cerulean-DVL
\nCerulean DVL driver, compatible with Blue Robotics BlueOS.
\nManual Installation:
\nTo set this up, ssh into the Raspberry Pi (or access via red-pill in BlueOS Terminal) and run
sudo docker run -d --net=host -v /root/.config/cerulean:/root/.config --name=BlueOS-Cerulean-DVL --restart=unless-stopped nicknothom/blueos-cerulean-dvl:latest
The service will show in the \"Available Services\" section in BlueOS, where there are some configuration options.
", "support": "https://forum.ceruleansonar.com/categories", "requirements": null, "company": { "about": "", "name": "Cerulean Sonar", "email": "dennys.bisogno@ceruleansonar.com" }, "permissions": { "NetworkMode": "host" } } }, "repo_info": { "downloads": 33614, "last_updated": "2023-05-17T18:58:43.418901Z", "date_registered": "2023-01-17T21:41:45.289578Z" } }, { "identifier": "ceruleansonar.sonarview", "name": "SonarView", "website": "https://sonarview.io/", "docker": "nicknothom/sonarview", "description": "Cross platform sonar viewing application", "extension_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/ceruleansonar/company_logo.png", "company_logo": "https://docs.bluerobotics.com/BlueOS-Extensions-Repository/repos/ceruleansonar/company_logo.png", "versions": { "1.14.48-dev": { "identifier": "09fa1d32-1eb7-5d85-ba02-fe5964f3961b", "type": "device-integration", "website": "https://ceruleansonar.com", "images": [ { "expanded_size": 81277747, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:e41f60e7928b3285e182dab21540e258cea901159185016ed8aeb8568641b647" }, { "expanded_size": 80790527, "platform": { "architecture": "arm64", "variant": null, "os": "linux" }, "digest": "sha256:2283c7710423d24478e5b72b791f660f8610b6a9b5e02d56a04ca6dd8b597997" }, { "expanded_size": 78633525, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:c637b4a58c579f620bb5f41b33772413328ffdb6af543527e34d4dc93990a013" } ], "authors": [ { "name": "Nick Nothom", "email": "nick.nothom@ceruleansonar.com" } ], "filter_tags": [], "extra_links": {}, "tag": "1.14.48-dev", "docs": null, "readme": "SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
SonarView
\nSonarView is a cross-platform application for controlling and communicating with sonar devices.
\nThis repository hosts the build and release process for SonarView.
\n- \n
- To download the desktop version of our software, get the latest release from our releases page \n
- If you're using BlueOS, download the extension from the BlueOS store \n
- For usage instructions, read manual on our website \n
BlueOS Cerulean Docs
\nHosts a mirror of the Cerulean Docs on the ROV so they can be viewed offline.
", "support": "https://forum.ceruleansonar.com/categories", "requirements": "core > 1", "company": { "about": "", "name": "Cerulean Sonar", "email": "dennys.bisogno@ceruleansonar.com" }, "permissions": { "NetworkMode": "host" } }, "v1.0.0": { "identifier": "e6424a8a-3f3c-5312-9511-6d58f284e9fe", "type": "other", "website": "https://ceruleansonar.com", "images": [ { "expanded_size": 175622566, "platform": { "architecture": "amd64", "variant": null, "os": "linux" }, "digest": "sha256:16039d43f4823cf408e2a44d93438c33caf6d00f4b716e4028b2e3314d04b40e" }, { "expanded_size": 170033285, "platform": { "architecture": "arm", "variant": "v7", "os": "linux" }, "digest": "sha256:a4dc00ddc3a2398ff400d2533b4f9eea53d19cce0a8df24b0f9595fa1c09fc4f" } ], "authors": [ { "name": "Nick Nothom", "email": "nick.nothom@ceruleansonar.com" } ], "filter_tags": [], "extra_links": {}, "tag": "v1.0.0", "docs": "", "readme": "BlueOS Cerulean Docs
\nHosts a mirror of the Cerulean Docs on the ROV so they can be viewed offline.
", "support": "https://forum.ceruleansonar.com/categories", "requirements": "core > 1", "company": { "about": "", "name": "Cerulean Sonar", "email": "dennys.bisogno@ceruleansonar.com" }, "permissions": { "ExposedPorts": { "80/tcp": {} }, "HostConfig": { "PortBindings": { "80/tcp": [ { "HostPort": "" } ] } } } } }, "repo_info": { "downloads": 9069, "last_updated": "2023-03-15T20:41:07.344116Z", "date_registered": "2023-03-02T18:19:41.09439Z" } } ]