{"id":25498533,"url":"https://github.com/rohit-554/lgserverswaggerapi","last_synced_at":"2026-01-24T06:03:14.536Z","repository":{"id":271450942,"uuid":"912989844","full_name":"Rohit-554/LgServerSwaggerApi","owner":"Rohit-554","description":"This repository serves API documentation for Lg-Server","archived":false,"fork":false,"pushed_at":"2025-07-20T08:03:36.000Z","size":2513,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-20T10:12:05.259Z","etag":null,"topics":["liquidgalaxy","server"],"latest_commit_sha":null,"homepage":"https://rohit-554.github.io/LgServerSwaggerApi/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Rohit-554.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-01-06T20:04:46.000Z","updated_at":"2025-07-20T08:03:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"299b461a-28b0-409d-b854-b689006f5019","html_url":"https://github.com/Rohit-554/LgServerSwaggerApi","commit_stats":null,"previous_names":["rohit-554/lgserverswaggerapi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Rohit-554/LgServerSwaggerApi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rohit-554%2FLgServerSwaggerApi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rohit-554%2FLgServerSwaggerApi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rohit-554%2FLgServerSwaggerApi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rohit-554%2FLgServerSwaggerApi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Rohit-554","download_url":"https://codeload.github.com/Rohit-554/LgServerSwaggerApi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rohit-554%2FLgServerSwaggerApi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28715580,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-24T05:53:42.649Z","status":"ssl_error","status_checked_at":"2026-01-24T05:53:41.698Z","response_time":89,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["liquidgalaxy","server"],"created_at":"2025-02-19T02:54:14.450Z","updated_at":"2026-01-24T06:03:14.531Z","avatar_url":"https://github.com/Rohit-554.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Liquid Galaxy [Server](https://github.com/LiquidGalaxyLAB/lg-server) Swagger API Documentation\n\n[View Documentation](https://liquidgalaxylab.github.io/LgServerSwaggerApi/)\n\nA comprehensive REST API documentation for controlling and managing Liquid Galaxy systems via SSH. This API enables developers to interact with Liquid Galaxy installations programmatically.\n\n## Overview\n\nThe Liquid Galaxy Control API provides endpoints for:\n\n- Managing system operations (reboot, relaunch)\n- Controlling visualizations and camera movements\n- Displaying custom content (logos, balloons)\n- Managing KML file deployments\n\n## Base URL\n\n```\nhttp://localhost:8000\n```\n\n## Authentication\n\nAll endpoints require SSH configuration parameters:\n\n```json\n{\n  \"ip\": \"192.168.201.3\",\n  \"port\": \"22\",\n  \"username\": \"lg\",\n  \"password\": \"lg\"\n}\n```\n\n## Available Endpoints\n\n### System Management\n\n- **POST /reboot-lg**: Full system reboot\n- **POST /relaunch-lg**: Restart LG software\n- **POST /clean-visualization**: Reset all visualizations\n\n### Navigation \u0026 Movement\n\n- **POST /start-orbit**: Start orbital movement\n- **POST /stop-orbit**: Stop orbital movement\n- **POST /flyto**: Navigate to specific coordinates\n\n### Content Display\n\n- **POST /show-logo**: Display logo (left-most rig)\n- **POST /clean-logos**: Remove logos\n- **POST /show-balloon**: Show information balloon (right-most rig)\n- **POST /clean-balloon**: Remove balloons\n- **POST /send-kml**: Upload and display KML file\n\n## Examples\n\nCheckout examples [here](https://liquidgalaxylab.github.io/LgServerSwaggerApi/examples/examples.txt)\n\n### Sending KML examples\n\u003chttp://localhost:8000/api/lg-connection/send-kml\u003e\n\n![image](https://github.com/user-attachments/assets/9cf9f467-f2fd-4c08-a5bd-485b11b7bb01)\n\n## Request Body Types\n\n### BasicSSHConfig\n\n```json\n{\n  \"ip\": \"192.168.201.3\",\n  \"port\": \"22\",\n  \"username\": \"lg\",\n  \"password\": \"lg\"\n}\n```\n\n### RigConfig\n\nExtends BasicSSHConfig with:\n\n```json\n{\n  \"rigs\": \"3\"  // Number of Liquid Galaxy \n}\n```\n\n### FlyToConfig\n\nExtends RigConfig with navigation parameters:\n\n```json\n{\n  \"latitude\": \"40.7128\",\n  \"longitude\": \"-74.0060\",\n  \"tilt\": \"45\",\n  \"bearing\": \"0\"\n}\n```\n\n### LogoConfig \u0026 BalloonConfig\n\nExtends RigConfig with:\n\n```json\n{\n  \"kml\": \"\u003ckml\u003e...\u003c/kml\u003e\"  // KML content for display\n}\n```\n\n## Response Formats\n\n### Success Response\n\n```json\n{\n  \"message\": \"Operation completed successfully\",\n  \"statusCode\": 200,\n  \"data\": \"\"\n}\n```\n\n### Error Response\n\n```json\n{\n  \"message\": \"Error description\",\n  \"statusCode\": 400,\n  \"stack\": \"Error stack trace\"\n}\n```\n\n## Special Notes\n\n1. **Screen Positioning**:\n   - Logos appear on the left-most rig\n   - Balloons appear on the right-most rig\n\n2. **KML File Upload**:\n   - Uses multipart/form-data\n   - Files should be in .txt format\n   - Requires filename parameter\n\n3. **Parameter Types**:\n   - All numeric values should be sent as strings\n   - Coordinates must be valid geographic values\n\n## Example Usage\n\n### Flying to a Location\n\n```bash\ncurl -X POST http://localhost:8000/flyto \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"ip\": \"192.168.201.3\",\n  \"port\": \"22\",\n  \"username\": \"lg\",\n  \"password\": \"lg\",\n  \"rigs\": \"3\",\n  \"latitude\": \"40.7128\",\n  \"longitude\": \"-74.0060\",\n  \"tilt\": \"45\",\n  \"bearing\": \"0\"\n}'\n```\n\n### Displaying a Logo\n\n```bash\ncurl -X POST http://localhost:8000/show-logo \\\n-H \"Content-Type: application/json\" \\\n-d '{\n  \"ip\": \"192.168.201.3\",\n  \"port\": \"22\",\n  \"username\": \"lg\",\n  \"password\": \"lg\",\n  \"rigs\": \"3\",\n  \"kml\": \"\u003ckml\u003e...\u003c/kml\u003e\"\n}'\n```\n\n## Best Practices\n\n1. Always clean visualizations before starting new ones\n2. Validate geographic coordinates before sending\n3. Test KML content in single-screen setup first\n4. Handle SSH connection errors appropriately\n5. Monitor system responses for success/failure\n\n## Development Setup\n\n1. Clone the repository\n2. Install dependencies\n3. Start local server\n4. Access Swagger documentation [here](https://liquidgalaxylab.github.io/LgServerSwaggerApi/)\n\n## API Security Considerations\n\n- Keep SSH credentials secure\n- Use environment variables for sensitive data\n- Implement rate limiting if needed\n- Validate all input parameters\n\n## Support\n\nFor issues and feature requests, please create an issue in the repository.\n\n## License\n\n[Add License Information](https://github.com/LiquidGalaxyLAB/LgServerSwaggerApi/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frohit-554%2Flgserverswaggerapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frohit-554%2Flgserverswaggerapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frohit-554%2Flgserverswaggerapi/lists"}