{"id":24020883,"url":"https://github.com/OptimumMeans/TRMNL-Ship-Tracker","last_synced_at":"2025-09-14T20:32:23.805Z","repository":{"id":268938759,"uuid":"905908954","full_name":"OptimumMeans/trmnl-ship-tracker","owner":"OptimumMeans","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-27T19:36:43.000Z","size":11338,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-27T20:25:08.879Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OptimumMeans.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-12-19T19:08:18.000Z","updated_at":"2024-12-27T19:36:47.000Z","dependencies_parsed_at":"2024-12-19T20:39:52.009Z","dependency_job_id":null,"html_url":"https://github.com/OptimumMeans/trmnl-ship-tracker","commit_stats":null,"previous_names":["optimummeans/trmnl-ship-tracker"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OptimumMeans%2Ftrmnl-ship-tracker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OptimumMeans%2Ftrmnl-ship-tracker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OptimumMeans%2Ftrmnl-ship-tracker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OptimumMeans%2Ftrmnl-ship-tracker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OptimumMeans","download_url":"https://codeload.github.com/OptimumMeans/trmnl-ship-tracker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233027386,"owners_count":18613648,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2025-01-08T12:19:05.540Z","updated_at":"2025-01-08T12:19:27.669Z","avatar_url":"https://github.com/OptimumMeans.png","language":"Python","funding_links":[],"categories":["🔌 Plugins - General"],"sub_categories":[],"readme":"# TRMNL Ship Tracker\n\nA TRMNL plugin for tracking ships using the VesselFinder API. This plugin displays real-time ship position, speed, course, and other relevant data on your TRMNL e-ink display.\n\n![image](https://github.com/user-attachments/assets/3f10afde-4809-486c-8db9-c17f82b6298f)\n\n## Features\n\n- Real-time ship position tracking\n- Speed and course display\n- Automatic refresh at configurable intervals\n- E-ink optimized display\n- Error handling and connection status\n\n## Prerequisites\n\n- Python 3.12+\n- TRMNL device and API key\n- VesselFinder API key\n- Docker (optional)\n\n## Installation\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/yourusername/ship-tracker.git\ncd ship-tracker\n```\n\n2. Create and activate a virtual environment:\n```bash\npython -m venv venv\nsource venv/bin/activate  # On Windows: venv\\Scripts\\activate\n```\n\n3. Install dependencies:\n```bash\npip install -r requirements.txt\n```\n\n4. Create .env file:\n```bash\ncp .env.template .env\n```\n\n5. Update .env with your configuration:\n```\nVESSELFINDER_API_KEY=your_api_key_here\nTRMNL_API_KEY=your_trmnl_api_key_here\nTRMNL_PLUGIN_UUID=your_plugin_uuid_here\n```\n\n## Running the Application\n\n### Development\n```bash\npython -m src.app\n```\n\n### Production\n```bash\ngunicorn src.app:app\n```\n\n## Configuration\n\nUpdate the following variables in your .env file:\n\n- `MMSI`: Ship's MMSI number to track\n- `REFRESH_INTERVAL`: How often to update the display (in seconds)\n- `DISPLAY_WIDTH`, `DISPLAY_HEIGHT`: Display dimensions\n- API keys and credentials\n\n## Development\n\n### Project Structure\n```\nship-tracker/\n├── src/               # Application source\n│   ├── services/     # Core services\n│   ├── templates/    # Display templates\n│   └── utils/        # Utility functions\n└── tests/            # Test files\n```\n\n### Adding New Features\n\n1. Create new service in `src/services/`\n2. Update display template in `src/templates/components/`\n3. Add configuration to `src/config.py`\n4. Update main app in `src/app.py`\n\n## Deployment\n\nDeploy using render.yaml configuration:\n\n```bash\nrender deploy\n```\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch\n3. Commit your changes\n4. Push to the branch\n5. Create a Pull Request\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOptimumMeans%2FTRMNL-Ship-Tracker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOptimumMeans%2FTRMNL-Ship-Tracker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOptimumMeans%2FTRMNL-Ship-Tracker/lists"}