Download the PHP package srwiez/starlink-client without Composer
On this page you can find all versions of the php package srwiez/starlink-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download srwiez/starlink-client
More information about srwiez/starlink-client
Files in srwiez/starlink-client
Package starlink-client
Short Description Starlink PHP Client using local gRPC communication
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package starlink-client
Starlink PHP Client
PHP client to monitor and control your Starlink dish via the local gRPC API.
This client uses the gRPC API of your Starlink device. API classes are generated based on the protoset file extracted from the reflection service of the Starlink device.
This client is not affiliated with SpaceX or Starlink.
It also comes with an obstruction map generator to visualize the obstruction map of the dish.
🚀 Installation
This package can be installed via composer, be aware that you need to have the grpc extension installed on your system.
📚 Usage
You can use the SRWieZ\StarlinkClient\Dishy class to interact with your Starlink device.
Getting the status
Get all the information about the device.
Get the sleep/powersave configuration
Get history of the following statistics:
- Ping drop rate
- Ping Latency
- Download speed
- Upload speed
- Power usage
If enabled in the settings of the mobile app, you can get the location of the dish.
Generate the obstruction map
You can obtain the obstruction map of the dish. For more information about the representation of each pixel in the data, refer to this link.
See result in the assets folder or the images above.
Send a command
Using the local gRPC API, you can send a limited set of commands to the user terminal. These commands are all listed below.
Advanced usage
If you prefer to use the gRPC client directly, you can use the generated DeviceClient class.
📋 TODO
Contributions are welcome!
- Finish CLI tool / examples
- Add more tests
- Create a script to generate proper enums and parse the values in the response to return those enums.
- Implement the authentication web API used by the mobile app to gain more control over the dish (e.g., snow melt mode, etc.).
🧑🔧 Building the client
If you have a starlink in your local network, you can update the client by running the following command.
Before running the command, make sure you have the grpcurl, protoc and grpc_php_plugin installed on your system.
🤝 Contributing
Clone the project and run composer update to install the dependencies.
Before pushing your changes, run composer qa.
This will run pint (code style), phpstan (static analysis), and pest (tests).
Additionally, if you have a Starlink dish on your local network, you can update the gRPC client by running ./update_client.sh. This command will update everything under the SpaceX namespace. After that, run composer qa to ensure everything is still functioning properly. If everything is fine and new functionality has been published by the gRPC reflection service, you can submit a pull request for your changes.
👥 Credits
Starlink PHP Client was created by Eser DENIZ.
The following projects inspired this library and served as a reference:
- https://github.com/ewilken/starlink-rs
- https://github.com/sparky8512/starlink-grpc-tools
- https://github.com/fullstorydev/grpcurl
📝 License
Starlink PHP Client is licensed under the MIT License. See LICENSE for more information.
