Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rugaard/oauth2-netatmo
Netatmo OAuth 2.0 support for the PHP League's OAuth 2.0 Client
https://github.com/rugaard/oauth2-netatmo
netatmo netatmo-api oauth oauth2 oauth2-netatmo php
Last synced: 9 days ago
JSON representation
Netatmo OAuth 2.0 support for the PHP League's OAuth 2.0 Client
- Host: GitHub
- URL: https://github.com/rugaard/oauth2-netatmo
- Owner: rugaard
- License: mit
- Created: 2019-01-13T16:06:17.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-13T16:20:59.000Z (about 6 years ago)
- Last Synced: 2024-12-12T12:51:04.035Z (about 1 month ago)
- Topics: netatmo, netatmo-api, oauth, oauth2, oauth2-netatmo, php
- Language: PHP
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Netatmo Provider for OAuth 2.0 Client
[](https://github.com/rugaard/oauth2-netatmo/releases)
[](LICENSE.md)
[](https://travis-ci.org/rugaard/oauth2-netatmo)
[](https://scrutinizer-ci.com/g/rugaard/oauth2-netatmo/code-structure)
[](https://scrutinizer-ci.com/g/rugaard/oauth2-netatmo)
[](https://packagist.org/packages/rugaard/oauth2-netatmo)
This package provides Netatmo OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/thephpleague/oauth2-client).
## Installation
To install, use composer:
```bash
composer require rugaard/oauth2-netatmo
```
## Usage
Usage is the same as The League's OAuth client, using `\Rugaard\OAuth2\Client\Netatmo\Provider\Netatmo` as the provider.
#### Initialize Provider
```php
$provider = new \Rugaard\OAuth2\Client\Netatmo\Provider\Netatmo([
'clientId' => '{netatmo-client-id}',
'clientSecret' => '{netatmo-client-secret}',
'redirectUri' => 'https://example.com/callback-url'
]);
```
#### Generate Authorization URL
```php
// Authorize with default scopes.
$url = $provider->getAuthorizationUrl();
// Authorize with other scopes.
$url = $provider->getAuthorizationUrl([
'scope' => ['read_scope', 'write_scope']
]);
```
To see which scopes are available, please refer to the [scopes section](#netatmo-scopes).
#### Generate and refresh tokens.
For further usage of this package please refer to the [core package documentation on "Authorization Code Grant"](https://github.com/thephpleague/oauth2-client#usage).
## Netatmo scopes
**Note**: This provider will always request the `read_thermostat` scope during authorization. Without this scope, Netatmo does not provide a generic way to fetch information about the "resource owner".
### List of available scopes
**Weather Station**
- `read_station`
**Thermostat**
- `read_thermostat`
- `write_thermostat`
**Home Coach**
- `read_homecoach`
**Welcome**
- `read_camera`
- `write_camera`
- `access_camera` _(requires app to have granted scope by Netatmo)_
**Presence**
- `access_presence` _(requires app to have granted scope by Netatmo)_
**Smoke Alarm**
- `read_smokedetector`
## Testing
```bash
$ ./vendor/bin/phpunit
```
## Contributing
Please see [CONTRIBUTING](https://github.com/rugaard/oauth2-netatmo/blob/master/CONTRIBUTING.md) for details.
## Credits
- [Morten Rugaard](https://github.com/rugaard)
- [All Contributors](https://github.com/rugaard/oauth2-netatmo/contributors)
## License
The MIT License (MIT). Please see [License File](https://github.com/rugaard/oauth2-netatmo/blob/master/LICENSE) for more information.