mirror of
https://github.com/skydiver/ewelink-api.git
synced 2025-12-24 06:28:30 +01:00
c11b3a8ab7
* updated dependencies * code linting * added new app id & app secret * cleanup requests payloads * remove unused function * update test cases * enabled firmware tests * refactor getDevice to use right api endpoint * error messages improvements * error messages improvements * error messages improvements * error messages improvements * error messages improvements * payload cleanup * refactor setDevicePowerState to use right api endpoint * update test exepectation * removed deprecated class * updated tests to reflect new error codes * error messages improvements * refactoring project structure: devices methods refactoring project sturcture * refactoring project structure: firmware methods * refactoring project structure: temperature/humidity * refactoring project structure: credentials methods * refactoring project structure: power usage methods * refactoring project structure: power state methods * refactoring project structure: websocket methods * removed deprecated login method from docs * refactoring project structure: power usage methods * refactoring project structure: zeroconf classes * refactoring project structure: websocket classes * refactoring project structure: zeroconf classes * refactor and cleanup * refactoring project structure: firmware methods * moved parsers to own directory * update tests with methods renames * export missing temperature/humidity methods * removed unused package * refactor and cleanup * fix test expectation * refactoring project structure: moved data files * refactoring project structure: moved data files * refactoring project structure: moved helpers files * refactoring project structure: moved helpers files * refactoring project structure: moved payload files * refactor and cleanup * refactor getDevicePowerState * setDevicePowerState returns channel * convert error 400 to 404 for clarity * updated test cases * remove console.log * cache path for zeroconf cache files * installed nock * using nock to simulate server requests during testing * moved credentials file to config folder * update request url when using nock * refactor nock helper file * move cooldown delay to setupTests file * updating testing instructions * restored delete code block * fix wrong error code * accept phone number to login to ewelink * added test cases for initialize main class * improvements on class initialization parameters * allow login using phone number * rename test file * updated test case * fixed regression bug * Release v3.0.0 - use node-fetch (#87) * replaced deprecated request library with node-fetch * refactor: moved makeRequest to own mixin file * refactor to use node-fetch * fixes * update config * created helper method * constant rename * ignore files from final package * version bump
70 lines
1.5 KiB
Markdown
70 lines
1.5 KiB
Markdown
# openWebSocket
|
|
|
|
Opens a socket connection to eWeLink and listen for realtime events.
|
|
|
|
|
|
### Usage
|
|
|
|
The `openWebSocket` method requires a callback function as an argument.
|
|
|
|
Once an event is received, the callback function will be executed with the server message as argument.
|
|
|
|
|
|
```js
|
|
// instantiate class
|
|
const connection = new ewelink({
|
|
email: '<your ewelink email>',
|
|
password: '<your ewelink password>',
|
|
region: '<your ewelink region>',
|
|
});
|
|
|
|
// login into eWeLink
|
|
await connection.getCredentials();
|
|
|
|
// call openWebSocket method with a callback as argument
|
|
const socket = await connection.openWebSocket(async data => {
|
|
// data is the message from eWeLink
|
|
console.log(data)
|
|
});
|
|
```
|
|
|
|
|
|
### Response example
|
|
|
|
If everything went well, the first message will have the following format:
|
|
```js
|
|
{
|
|
error: 0,
|
|
apikey: '12345678-9012-3456-7890-123456789012',
|
|
config: {
|
|
hb: 1,
|
|
hbInterval: 12345
|
|
},
|
|
sequence: '1234567890123'
|
|
}
|
|
```
|
|
|
|
When a device change his status, a similar message will be returned:
|
|
```js
|
|
{
|
|
action: 'update',
|
|
deviceid: '1234567890',
|
|
apikey: '12345678-9012-3456-7890-123456789012',
|
|
userAgent: 'device',
|
|
sequence: '1234567890123'
|
|
ts: 0,
|
|
params: {
|
|
switch: 'on'
|
|
},
|
|
from: 'device',
|
|
seq: '11'
|
|
}
|
|
```
|
|
|
|
|
|
|
|
### Notes
|
|
|
|
* Because of the nature of a socket connection, the script will keep running until the connection gets closed.
|
|
* `openWebSocket` will return the socket instance
|
|
* if you need to manually kill the connection, just run `socket.close()` (where socket is the variable used). |