Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nioc/synology-srm-php-api
PHP wrapper for Synology Router Manager (SRM) API
https://github.com/nioc/synology-srm-php-api
router srm synology
Last synced: 9 days ago
JSON representation
PHP wrapper for Synology Router Manager (SRM) API
- Host: GitHub
- URL: https://github.com/nioc/synology-srm-php-api
- Owner: nioc
- License: agpl-3.0
- Created: 2020-05-02T14:13:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-27T21:09:08.000Z (about 2 years ago)
- Last Synced: 2024-10-11T01:45:14.250Z (26 days ago)
- Topics: router, srm, synology
- Language: PHP
- Homepage:
- Size: 19.5 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Synology SRM PHP API
[](https://www.gnu.org/licenses/agpl-3.0)
[](https://github.com/nioc/synology-srm-php-api/releases/latest)
[](https://packagist.org/packages/nioc/synology-srm-php-api)
[](https://github.com/nioc/synology-srm-php-api/releases)
API wrapper for Synology Router Manager (SRM).
## Key features
- get WAN status,
- get network utilization,
- get devices with status, IP, etc... ,
- get wifi devices with link quality, signal strength, max rate, band used, etc... ,
- get devices traffic usage (live, day, week, month),
- get mesh nodes with status, connected devices, etc... ,
- get wake-on-lan devices,
- get access control groups with devices, online status, etc... ,
- add wake-on-lan on a device,
- wake-on-lan a device.
## Installation
To install with composer:
```shell
composer require nioc/synology-srm-php-api
```
Or download [latest release](https://github.com/nioc/synology-srm-php-api/releases/latest) zip archive,
## Usage
### Create client
#### Create a simple client
```php
$client = new SrmClient(null, $username, $password, $hostname, $port, $https, false);
```
#### Create a client with session keeped
If you can store session id, you can pass it value to constructor. if value is `null`, client will execute a login request.
```php
$client = new SrmClient(null, $username, $password, $hostname, $port, $https, true, $sid);
```
To retrieve session id value in order to store it:
```php
$sid = $client->getSid();
```
#### Create a client with logger
Constructor first parameter is `LoggerInterface`, allowing you to use any PSR-3 compliant logger library (like [Monolog](https://github.com/Seldaek/monolog) or [Analog](https://github.com/jbroadway/analog)).
Following a basic console logger with Analog:
```php
use Analog\Logger;
use Analog\Handler\EchoConsole;
$logger = new Logger;
Analog::$format = "%s - %s - %s - %s\n";
$logger->handler(
Analog\Handler\Threshold::init(
Analog\Handler\LevelName::init(
EchoConsole::init()
),
Analog::INFO
)
);
$client = new SrmClient($logger, $username, $password, $hostname, $port, $https, true, $sid);
```
### Get devices, mesh, traffic, ...
Simply call the requested client method, exemple with traffic:
```php
$devicesTraffic = $client->getTraffic('live');
```
You can see a full exemple [here](https://github.com/nioc/synology-srm-php-api/blob/master/example.php).
## Versioning
This library is maintained under the [semantic versioning](https://semver.org/) guidelines.
See the [releases](https://github.com/nioc/synology-srm-php-api/releases) on this repository for changelog.
## Contributing
If you have a suggestion, please submit a [feature request](https://github.com/nioc/synology-srm-php-api/issues/new?labels=enhancement).
Pull requests are welcomed.
## Credits
* **[Nioc](https://github.com/nioc/)** - *Initial work*
See also the list of [contributors](https://github.com/nioc/synology-srm-php-api/contributors) to this project.
## License
This project is licensed under the GNU Affero General Public License v3.0 - see the [LICENSE](LICENSE.md) file for details