mirror of
https://github.com/bourquep/mysa-js-sdk.git
synced 2026-02-04 09:41:07 +00:00
Compare commits
44 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d813c4f9a9 | ||
|
|
598edf50d9 | ||
|
|
ad34fe7486 | ||
|
|
daed17753e | ||
|
|
b845fe5a82 | ||
|
|
bb876ef60d | ||
|
|
2aa7bd1679 | ||
|
|
df16d2553b | ||
|
|
55ec9a8fe9 | ||
|
|
77e972bde2 | ||
|
|
ed8a83f89b | ||
|
|
aa6ed44a19 | ||
|
|
98003665b8 | ||
|
|
7afec1a7a9 | ||
|
|
e6631b0fd8 | ||
|
|
efaf3310d2 | ||
|
|
a62b538c42 | ||
|
|
2023e8b321 | ||
|
|
808e8f1037 | ||
|
|
f201c7944a | ||
|
|
f6c6127dab | ||
|
|
73cec9a90e | ||
|
|
39fc9048df | ||
|
|
45d69453df | ||
|
|
6dc6da2dde | ||
|
|
0cf7a1756c | ||
|
|
51b8f64dab | ||
|
|
14ee1d30eb | ||
|
|
4680ca2f85 | ||
|
|
3f020d5dc3 | ||
|
|
e93741525c | ||
|
|
9b945869aa | ||
|
|
becafbfacc | ||
|
|
c29e750f9c | ||
|
|
e3c93453ed | ||
|
|
17f277e844 | ||
|
|
6a88e52702 | ||
|
|
d6971453d2 | ||
|
|
8769928622 | ||
|
|
131f8677d9 | ||
|
|
ba5d29379a | ||
|
|
0dfb486ea1 | ||
|
|
2c483a835d | ||
|
|
7f89e9867a |
22
.all-contributorsrc
Normal file
22
.all-contributorsrc
Normal file
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"files": ["README.md"],
|
||||
"imageSize": 100,
|
||||
"commit": false,
|
||||
"commitType": "docs",
|
||||
"commitConvention": "angular",
|
||||
"contributors": [
|
||||
{
|
||||
"login": "jagmandan",
|
||||
"name": "jagmandan",
|
||||
"avatar_url": "https://avatars.githubusercontent.com/u/227265405?v=4",
|
||||
"profile": "https://github.com/jagmandan",
|
||||
"contributions": ["code"]
|
||||
}
|
||||
],
|
||||
"contributorsPerLine": 7,
|
||||
"skipCi": true,
|
||||
"repoType": "github",
|
||||
"repoHost": "https://github.com",
|
||||
"projectName": "mysa-js-sdk",
|
||||
"projectOwner": "bourquep"
|
||||
}
|
||||
100
.github/workflows/codeql.yml
vendored
Normal file
100
.github/workflows/codeql.yml
vendored
Normal file
@@ -0,0 +1,100 @@
|
||||
# For most projects, this workflow file will not need changing; you simply need
|
||||
# to commit it to your repository.
|
||||
#
|
||||
# You may wish to alter this file to override the set of languages analyzed,
|
||||
# or to provide custom queries or build logic.
|
||||
#
|
||||
# ******** NOTE ********
|
||||
# We have attempted to detect the languages in your repository. Please check
|
||||
# the `language` matrix defined below to confirm you have the correct set of
|
||||
# supported CodeQL languages.
|
||||
#
|
||||
name: 'CodeQL Advanced'
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: ['main']
|
||||
pull_request:
|
||||
branches: ['main']
|
||||
schedule:
|
||||
- cron: '44 5 * * 5'
|
||||
|
||||
jobs:
|
||||
analyze:
|
||||
name: Analyze (${{ matrix.language }})
|
||||
# Runner size impacts CodeQL analysis time. To learn more, please see:
|
||||
# - https://gh.io/recommended-hardware-resources-for-running-codeql
|
||||
# - https://gh.io/supported-runners-and-hardware-resources
|
||||
# - https://gh.io/using-larger-runners (GitHub.com only)
|
||||
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
|
||||
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
|
||||
permissions:
|
||||
# required for all workflows
|
||||
security-events: write
|
||||
|
||||
# required to fetch internal or private CodeQL packs
|
||||
packages: read
|
||||
|
||||
# only required for workflows in private repositories
|
||||
actions: read
|
||||
contents: read
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- language: actions
|
||||
build-mode: none
|
||||
- language: javascript-typescript
|
||||
build-mode: none
|
||||
# CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
|
||||
# Use `c-cpp` to analyze code written in C, C++ or both
|
||||
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
|
||||
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
|
||||
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
|
||||
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
|
||||
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
|
||||
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# Add any setup steps before running the `github/codeql-action/init` action.
|
||||
# This includes steps like installing compilers or runtimes (`actions/setup-node`
|
||||
# or others). This is typically only required for manual builds.
|
||||
# - name: Setup runtime (example)
|
||||
# uses: actions/setup-example@v1
|
||||
|
||||
# Initializes the CodeQL tools for scanning.
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@v3
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
build-mode: ${{ matrix.build-mode }}
|
||||
# If you wish to specify custom queries, you can do so here or in a config file.
|
||||
# By default, queries listed here will override any specified in a config file.
|
||||
# Prefix the list here with "+" to use these queries and those in the config file.
|
||||
|
||||
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
|
||||
# queries: security-extended,security-and-quality
|
||||
|
||||
# If the analyze step fails for one of the languages you are analyzing with
|
||||
# "We were unable to automatically build your code", modify the matrix above
|
||||
# to set the build mode to "manual" for that language. Then modify this step
|
||||
# to build your code.
|
||||
# ℹ️ Command-line programs to run using the OS shell.
|
||||
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
|
||||
- if: matrix.build-mode == 'manual'
|
||||
shell: bash
|
||||
run: |
|
||||
echo 'If you are using a "manual" build mode for one or more of the' \
|
||||
'languages you are analyzing, replace this with the commands to build' \
|
||||
'your code, for example:'
|
||||
echo ' make bootstrap'
|
||||
echo ' make release'
|
||||
exit 1
|
||||
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@v3
|
||||
with:
|
||||
category: '/language:${{matrix.language}}'
|
||||
35
README.md
35
README.md
@@ -1,5 +1,11 @@
|
||||
# Mysa Smart Thermostat JavaScript SDK
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||
|
||||
[](#contributors-)
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||
|
||||
[](https://www.npmjs.com/package/mysa-js-sdk)
|
||||
[](https://github.com/bourquep/mysa-js-sdk/actions/workflows/github-code-scanning/codeql)
|
||||
[](https://github.com/bourquep/mysa-js-sdk/actions/workflows/ci.yml)
|
||||
@@ -51,6 +57,12 @@ Then, run the example:
|
||||
npm run example
|
||||
```
|
||||
|
||||
If you prefer to see the raw data published by your Mysa smart thermostats, run:
|
||||
|
||||
```bash
|
||||
npm run example:raw
|
||||
```
|
||||
|
||||
## Using
|
||||
|
||||
The Mysa SDK provides a simple interface to interact with Mysa smart thermostats.
|
||||
@@ -223,3 +235,26 @@ For general questions and discussions, join our [Discussion Forum](https://githu
|
||||
This library would not be possible without the amazing work by [@dlenski](https://github.com/dlenski) in his
|
||||
[mysotherm](https://github.com/dlenski/mysotherm) repository. He's the one who reversed-engineered the Mysa MQTT
|
||||
protocol which is being used by this library.
|
||||
|
||||
## Contributors ✨
|
||||
|
||||
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-disable -->
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/jagmandan"><img src="https://avatars.githubusercontent.com/u/227265405?v=4?s=100" width="100px;" alt="jagmandan"/><br /><sub><b>jagmandan</b></sub></a><br /><a href="https://github.com/bourquep/mysa-js-sdk/commits?author=jagmandan" title="Code">💻</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||
|
||||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
|
||||
Contributions of any kind welcome!
|
||||
|
||||
@@ -57,39 +57,50 @@ async function main() {
|
||||
|
||||
const devices = await client.getDevices();
|
||||
|
||||
client.emitter.on('statusChanged', (status) => {
|
||||
try {
|
||||
const device = devices.DevicesObj[status.deviceId];
|
||||
const watts = status.current !== undefined ? status.current * device.Voltage : undefined;
|
||||
rootLogger.info(
|
||||
`'${device.Name}' status changed: ${status.temperature}°C, ${status.humidity}%, ${watts ?? 'na'}W`
|
||||
);
|
||||
} catch (error) {
|
||||
rootLogger.error(`Error processing status update for device '${status.deviceId}':`, error);
|
||||
}
|
||||
});
|
||||
if (process.env.MYSA_OUTPUT_RAW_DATA === 'true') {
|
||||
client.emitter.on('rawRealtimeMessageReceived', (data) => {
|
||||
rootLogger.info(data, 'Raw message received');
|
||||
});
|
||||
} else {
|
||||
client.emitter.on('statusChanged', (status) => {
|
||||
try {
|
||||
const device = devices.DevicesObj[status.deviceId];
|
||||
const watts = status.current !== undefined ? status.current * device.Voltage : undefined;
|
||||
rootLogger.info(
|
||||
`'${device.Name}' status changed: ${status.temperature}°C, ${status.humidity}%, ${watts ?? 'na'}W`
|
||||
);
|
||||
} catch (error) {
|
||||
rootLogger.error(error, `Error processing status update for device '${status.deviceId}'`);
|
||||
}
|
||||
});
|
||||
|
||||
client.emitter.on('setPointChanged', (change) => {
|
||||
try {
|
||||
const device = devices.DevicesObj[change.deviceId];
|
||||
rootLogger.info(`'${device.Name}' setpoint changed from ${change.previousSetPoint} to ${change.newSetPoint}`);
|
||||
} catch (error) {
|
||||
rootLogger.error(`Error processing setpoint update for device '${change.deviceId}':`, error);
|
||||
}
|
||||
});
|
||||
client.emitter.on('setPointChanged', (change) => {
|
||||
try {
|
||||
const device = devices.DevicesObj[change.deviceId];
|
||||
rootLogger.info(`'${device.Name}' setpoint changed from ${change.previousSetPoint} to ${change.newSetPoint}`);
|
||||
} catch (error) {
|
||||
rootLogger.error(error, `Error processing setpoint update for device '${change.deviceId}'`);
|
||||
}
|
||||
});
|
||||
|
||||
client.emitter.on('stateChanged', (change) => {
|
||||
try {
|
||||
const device = devices.DevicesObj[change.deviceId];
|
||||
rootLogger.info(change, `'${device.Name}' state changed.`);
|
||||
} catch (error) {
|
||||
rootLogger.error(`Error processing setpoint update for device '${change.deviceId}':`, error);
|
||||
}
|
||||
});
|
||||
|
||||
for (const device of Object.entries(devices.DevicesObj)) {
|
||||
await client.startRealtimeUpdates(device[0]);
|
||||
client.emitter.on('stateChanged', (change) => {
|
||||
try {
|
||||
const device = devices.DevicesObj[change.deviceId];
|
||||
rootLogger.info(change, `'${device.Name}' state changed.`);
|
||||
} catch (error) {
|
||||
rootLogger.error(error, `Error processing state update for device '${change.deviceId}'`);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
await Promise.all(
|
||||
Object.entries(devices.DevicesObj).map(async ([deviceId, device]) => {
|
||||
const serial = await client.getDeviceSerialNumber(deviceId);
|
||||
rootLogger.info(`Serial number for device '${deviceId}' (${device.Name}): ${serial}`);
|
||||
|
||||
await client.startRealtimeUpdates(deviceId);
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
main().catch((error) => {
|
||||
|
||||
2160
package-lock.json
generated
2160
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
43
package.json
43
package.json
@@ -40,39 +40,44 @@
|
||||
"browser": false,
|
||||
"scripts": {
|
||||
"example": "tsx --watch ./example/main.ts",
|
||||
"example:raw": "MYSA_OUTPUT_RAW_DATA=true tsx --watch ./example/main.ts",
|
||||
"lint": "eslint --max-warnings 0 src/**/*.ts",
|
||||
"style-lint": "prettier -c .",
|
||||
"build": "tsup",
|
||||
"build:docs": "typedoc"
|
||||
},
|
||||
"overrides": {
|
||||
"brace-expansion": "^2.0.2"
|
||||
},
|
||||
"dependencies": {
|
||||
"@aws-sdk/credential-providers": "3.821.0",
|
||||
"@aws-sdk/client-iot": "3.901.0",
|
||||
"@aws-sdk/credential-providers": "3.901.0",
|
||||
"amazon-cognito-identity-js": "6.3.15",
|
||||
"aws-iot-device-sdk-v2": "1.21.4",
|
||||
"aws-iot-device-sdk-v2": "1.22.0",
|
||||
"dayjs": "1.11.13",
|
||||
"lodash": "4.17.21"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@eslint/js": "9.28.0",
|
||||
"@semantic-release/npm": "12.0.1",
|
||||
"@types/lodash": "4.17.17",
|
||||
"@types/node": "22.15.29",
|
||||
"conventional-changelog-conventionalcommits": "9.0.0",
|
||||
"dotenv": "16.5.0",
|
||||
"eslint": "9.28.0",
|
||||
"eslint-plugin-jsdoc": "50.7.1",
|
||||
"@eslint/js": "9.34.0",
|
||||
"@semantic-release/npm": "12.0.2",
|
||||
"@types/lodash": "4.17.20",
|
||||
"@types/node": "24.3.0",
|
||||
"conventional-changelog-conventionalcommits": "9.1.0",
|
||||
"dotenv": "17.2.1",
|
||||
"eslint": "9.34.0",
|
||||
"eslint-plugin-jsdoc": "54.1.1",
|
||||
"eslint-plugin-tsdoc": "0.4.0",
|
||||
"pino": "9.7.0",
|
||||
"pino": "9.13.0",
|
||||
"pino-pretty": "13.0.0",
|
||||
"prettier": "3.5.3",
|
||||
"prettier-plugin-jsdoc": "1.3.2",
|
||||
"prettier-plugin-organize-imports": "4.1.0",
|
||||
"semantic-release": "24.2.5",
|
||||
"prettier": "3.6.2",
|
||||
"prettier-plugin-jsdoc": "1.3.3",
|
||||
"prettier-plugin-organize-imports": "4.2.0",
|
||||
"semantic-release": "24.2.7",
|
||||
"tsup": "8.5.0",
|
||||
"tsx": "4.19.4",
|
||||
"typedoc": "0.28.5",
|
||||
"tsx": "4.20.3",
|
||||
"typedoc": "0.28.13",
|
||||
"typedoc-material-theme": "1.4.0",
|
||||
"typescript": "5.8.3",
|
||||
"typescript-eslint": "8.33.0"
|
||||
"typescript": "5.9.2",
|
||||
"typescript-eslint": "8.41.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -7,6 +7,7 @@ import { InMessageType } from '@/types/mqtt/in/InMessageType';
|
||||
import { StartPublishingDeviceStatus } from '@/types/mqtt/in/StartPublishingDeviceStatus';
|
||||
import { OutMessageType } from '@/types/mqtt/out/OutMessageType';
|
||||
import { Devices, DeviceStates, Firmwares } from '@/types/rest';
|
||||
import { DescribeThingCommand, IoTClient } from '@aws-sdk/client-iot';
|
||||
import { fromCognitoIdentityPool } from '@aws-sdk/credential-providers';
|
||||
import {
|
||||
AuthenticationDetails,
|
||||
@@ -19,7 +20,7 @@ import {
|
||||
} from 'amazon-cognito-identity-js';
|
||||
import { iot, mqtt } from 'aws-iot-device-sdk-v2';
|
||||
import dayjs from 'dayjs';
|
||||
import duration from 'dayjs/plugin/duration';
|
||||
import duration from 'dayjs/plugin/duration.js';
|
||||
import { MysaApiError, UnauthenticatedError } from './Errors';
|
||||
import { Logger, VoidLogger } from './Logger';
|
||||
import { MysaApiClientEventTypes } from './MysaApiClientEventTypes';
|
||||
@@ -74,8 +75,8 @@ export class MysaApiClient {
|
||||
/** The fetcher function used by the client. */
|
||||
private _fetcher: typeof fetch;
|
||||
|
||||
/** The MQTT connection used for real-time updates. */
|
||||
private _mqttConnection?: mqtt.MqttClientConnection;
|
||||
/** A promise that resolves to the MQTT connection used for real-time updates. */
|
||||
private _mqttConnectionPromise?: Promise<mqtt.MqttClientConnection>;
|
||||
|
||||
/** The device IDs that are currently being updated in real-time, mapped to their respective timeouts. */
|
||||
private _realtimeDeviceIds: Map<string, NodeJS.Timeout> = new Map();
|
||||
@@ -143,8 +144,23 @@ export class MysaApiClient {
|
||||
/**
|
||||
* Logs in the user with the given email address and password.
|
||||
*
|
||||
* This method authenticates the user with Mysa's Cognito user pool and establishes a session that can be used for
|
||||
* subsequent API calls. Upon successful login, a 'sessionChanged' event is emitted.
|
||||
*
|
||||
* @example
|
||||
*
|
||||
* ```typescript
|
||||
* try {
|
||||
* await client.login('user@example.com', 'password123');
|
||||
* console.log('Login successful!');
|
||||
* } catch (error) {
|
||||
* console.error('Login failed:', error.message);
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @param emailAddress - The email address of the user.
|
||||
* @param password - The password of the user.
|
||||
* @throws {@link Error} When authentication fails due to invalid credentials or network issues.
|
||||
*/
|
||||
async login(emailAddress: string, password: string): Promise<void> {
|
||||
this._cognitoUser = undefined;
|
||||
@@ -175,7 +191,21 @@ export class MysaApiClient {
|
||||
/**
|
||||
* Retrieves the list of devices associated with the user.
|
||||
*
|
||||
* This method fetches all Mysa devices linked to the authenticated user's account, including device information such
|
||||
* as models, locations, and configuration details.
|
||||
*
|
||||
* @example
|
||||
*
|
||||
* ```typescript
|
||||
* const devices = await client.getDevices();
|
||||
* for (const [deviceId, device] of Object.entries(devices.DevicesObj)) {
|
||||
* console.log(`Device: ${device.DisplayName} (${device.Model})`);
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @returns A promise that resolves to the list of devices.
|
||||
* @throws {@link MysaApiError} When the API request fails.
|
||||
* @throws {@link UnauthenticatedError} When the user is not authenticated.
|
||||
*/
|
||||
async getDevices(): Promise<Devices> {
|
||||
this._logger.debug(`Fetching devices...`);
|
||||
@@ -195,6 +225,70 @@ export class MysaApiClient {
|
||||
return response.json();
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the serial number for a specific device.
|
||||
*
|
||||
* This method uses AWS IoT's DescribeThing API to fetch the serial number attribute for the specified device. This
|
||||
* requires additional AWS IoT permissions and may not be available for all devices.
|
||||
*
|
||||
* @example
|
||||
*
|
||||
* ```typescript
|
||||
* const serialNumber = await client.getDeviceSerialNumber('device123');
|
||||
* if (serialNumber) {
|
||||
* console.log(`Device serial: ${serialNumber}`);
|
||||
* } else {
|
||||
* console.log('Serial number not available');
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @param deviceId - The ID of the device to get the serial number for.
|
||||
* @returns A promise that resolves to the serial number, or undefined if not found.
|
||||
* @throws {@link UnauthenticatedError} When the user is not authenticated.
|
||||
*/
|
||||
async getDeviceSerialNumber(deviceId: string): Promise<string | undefined> {
|
||||
this._logger.debug(`Fetching serial number for device ${deviceId}...`);
|
||||
|
||||
const session = await this.getFreshSession();
|
||||
|
||||
// Get AWS credentials for IoT client
|
||||
const credentialsProvider = fromCognitoIdentityPool({
|
||||
clientConfig: {
|
||||
region: AwsRegion
|
||||
},
|
||||
identityPoolId: CognitoIdentityPoolId,
|
||||
logins: {
|
||||
[CognitoLoginKey]: session.getIdToken().getJwtToken()
|
||||
}
|
||||
});
|
||||
|
||||
const credentials = await credentialsProvider();
|
||||
const iotClient = new IoTClient({
|
||||
region: AwsRegion,
|
||||
credentials: {
|
||||
accessKeyId: credentials.accessKeyId,
|
||||
secretAccessKey: credentials.secretAccessKey,
|
||||
sessionToken: credentials.sessionToken
|
||||
}
|
||||
});
|
||||
|
||||
try {
|
||||
const command = new DescribeThingCommand({ thingName: deviceId });
|
||||
const response = await iotClient.send(command);
|
||||
return response.attributes?.['Serial'];
|
||||
} catch (error) {
|
||||
this._logger.warn(`Could not get serial number for device ${deviceId}:`, error);
|
||||
return undefined;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves firmware information for all devices.
|
||||
*
|
||||
* @returns A promise that resolves to the firmware information for all devices.
|
||||
* @throws {@link MysaApiError} When the API request fails.
|
||||
* @throws {@link UnauthenticatedError} When the user is not authenticated.
|
||||
*/
|
||||
async getDeviceFirmwares(): Promise<Firmwares> {
|
||||
this._logger.debug(`Fetching device firmwares...`);
|
||||
|
||||
@@ -213,6 +307,13 @@ export class MysaApiClient {
|
||||
return response.json();
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the current state information for all devices.
|
||||
*
|
||||
* @returns A promise that resolves to the current state of all devices.
|
||||
* @throws {@link MysaApiError} When the API request fails.
|
||||
* @throws {@link UnauthenticatedError} When the user is not authenticated.
|
||||
*/
|
||||
async getDeviceStates(): Promise<DeviceStates> {
|
||||
this._logger.debug(`Fetching device states...`);
|
||||
|
||||
@@ -231,6 +332,31 @@ export class MysaApiClient {
|
||||
return response.json();
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the state of a specific device by sending commands via MQTT.
|
||||
*
|
||||
* This method allows you to change the temperature set point and/or operating mode of a Mysa device. The command is
|
||||
* sent through the MQTT connection for real-time device control.
|
||||
*
|
||||
* @example
|
||||
*
|
||||
* ```typescript
|
||||
* // Set temperature to 22°C
|
||||
* await client.setDeviceState('device123', 22);
|
||||
*
|
||||
* // Turn device off
|
||||
* await client.setDeviceState('device123', undefined, 'off');
|
||||
*
|
||||
* // Set temperature and mode
|
||||
* await client.setDeviceState('device123', 20, 'heat');
|
||||
* ```
|
||||
*
|
||||
* @param deviceId - The ID of the device to control.
|
||||
* @param setPoint - The target temperature set point (optional).
|
||||
* @param mode - The operating mode to set ('off', 'heat', or undefined to leave unchanged).
|
||||
* @throws {@link UnauthenticatedError} When the user is not authenticated.
|
||||
* @throws {@link Error} When MQTT connection or command sending fails.
|
||||
*/
|
||||
async setDeviceState(deviceId: string, setPoint?: number, mode?: MysaDeviceMode) {
|
||||
this._logger.debug(`Setting device state for '${deviceId}'`);
|
||||
|
||||
@@ -248,7 +374,7 @@ export class MysaApiClient {
|
||||
this._logger.debug(`Sending request to set device state for '${deviceId}'...`);
|
||||
const payload = serializeMqttPayload<ChangeDeviceState>({
|
||||
msg: InMessageType.CHANGE_DEVICE_STATE,
|
||||
id: now.unix(),
|
||||
id: now.valueOf(),
|
||||
time: now.unix(),
|
||||
ver: '1.0',
|
||||
src: {
|
||||
@@ -285,13 +411,29 @@ export class MysaApiClient {
|
||||
/**
|
||||
* Starts receiving real-time updates for the specified device.
|
||||
*
|
||||
* This method establishes an MQTT subscription to receive live status updates from the device, including temperature,
|
||||
* humidity, set point changes, and other state information. The client will automatically send keep-alive messages to
|
||||
* maintain the connection.
|
||||
*
|
||||
* @example
|
||||
*
|
||||
* ```typescript
|
||||
* // Start receiving updates and listen for events
|
||||
* await client.startRealtimeUpdates('device123');
|
||||
*
|
||||
* client.emitter.on('statusChanged', (status) => {
|
||||
* console.log(`Temperature: ${status.temperature}°C`);
|
||||
* });
|
||||
* ```
|
||||
*
|
||||
* @param deviceId - The ID of the device to start receiving updates for.
|
||||
* @throws {@link Error} When MQTT connection or subscription fails.
|
||||
*/
|
||||
async startRealtimeUpdates(deviceId: string) {
|
||||
this._logger.info(`Starting realtime updates for device '${deviceId}'`);
|
||||
this._logger.info(`Starting real-time updates for device '${deviceId}'`);
|
||||
|
||||
if (this._realtimeDeviceIds.has(deviceId)) {
|
||||
this._logger.debug(`Realtime updates for device '${deviceId}' already started`);
|
||||
this._logger.debug(`Real-time updates for device '${deviceId}' already started`);
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -329,9 +471,15 @@ export class MysaApiClient {
|
||||
/**
|
||||
* Stops receiving real-time updates for the specified device.
|
||||
*
|
||||
* This method unsubscribes from the MQTT topic for the specified device and clears any associated timers to stop the
|
||||
* keep-alive messages.
|
||||
*
|
||||
* @param deviceId - The ID of the device to stop receiving real-time updates for.
|
||||
* @throws {@link Error} When MQTT unsubscription fails.
|
||||
*/
|
||||
async stopRealtimeUpdates(deviceId: string) {
|
||||
this._logger.info(`Stopping real-time updates for device '${deviceId}'`);
|
||||
|
||||
const timer = this._realtimeDeviceIds.get(deviceId);
|
||||
if (!timer) {
|
||||
this._logger.warn(`No real-time updates are running for device '${deviceId}'`);
|
||||
@@ -344,11 +492,19 @@ export class MysaApiClient {
|
||||
this._logger.debug(`Unsubscribing to MQTT topic '/v1/dev/${deviceId}/out'...`);
|
||||
await mqttConnection.unsubscribe(`/v1/dev/${deviceId}/out`);
|
||||
|
||||
this._logger.debug(`Stopping real-time updates for device '${deviceId}'...`);
|
||||
clearInterval(timer);
|
||||
this._realtimeDeviceIds.delete(deviceId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures a valid, non-expired session is available.
|
||||
*
|
||||
* This method checks if the current session is valid and not expired. If the session is expired, it automatically
|
||||
* refreshes it using the refresh token.
|
||||
*
|
||||
* @returns A promise that resolves to a valid CognitoUserSession.
|
||||
* @throws {@link UnauthenticatedError} When no session exists or refresh fails.
|
||||
*/
|
||||
private async getFreshSession(): Promise<CognitoUserSession> {
|
||||
if (!this._cognitoUser || !this._cognitoUserSession) {
|
||||
throw new UnauthenticatedError('An attempt was made to access a resource without a valid session.');
|
||||
@@ -358,18 +514,18 @@ export class MysaApiClient {
|
||||
this._cognitoUserSession.isValid() &&
|
||||
dayjs.unix(this._cognitoUserSession.getIdToken().getExpiration()).isAfter()
|
||||
) {
|
||||
this._logger.info('Session is valid, no need to refresh');
|
||||
this._logger.debug('Session is valid, no need to refresh');
|
||||
return Promise.resolve(this._cognitoUserSession);
|
||||
}
|
||||
|
||||
this._logger.info('Session is not valid or expired, refreshing...');
|
||||
this._logger.debug('Session is not valid or expired, refreshing...');
|
||||
return new Promise<CognitoUserSession>((resolve, reject) => {
|
||||
this._cognitoUser!.refreshSession(this._cognitoUserSession!.getRefreshToken(), (error, session) => {
|
||||
if (error) {
|
||||
this._logger.error('Failed to refresh session:', error);
|
||||
reject(new UnauthenticatedError('Unable to refresh the authentication session.'));
|
||||
} else {
|
||||
this._logger.info('Session refreshed successfully');
|
||||
this._logger.debug('Session refreshed successfully');
|
||||
this._cognitoUserSession = session;
|
||||
this.emitter.emit('sessionChanged', this.session);
|
||||
resolve(session);
|
||||
@@ -378,11 +534,33 @@ export class MysaApiClient {
|
||||
});
|
||||
}
|
||||
|
||||
private async getMqttConnection(): Promise<mqtt.MqttClientConnection> {
|
||||
if (this._mqttConnection) {
|
||||
return this._mqttConnection;
|
||||
/**
|
||||
* Establishes and returns an MQTT connection for real-time communication.
|
||||
*
|
||||
* This method creates a new MQTT connection if one doesn't exist, using AWS IoT WebSocket connections with Cognito
|
||||
* credentials. The connection is cached and reused for subsequent calls.
|
||||
*
|
||||
* @returns A promise that resolves to an active MQTT connection.
|
||||
* @throws {@link Error} When connection establishment fails.
|
||||
*/
|
||||
private getMqttConnection(): Promise<mqtt.MqttClientConnection> {
|
||||
if (!this._mqttConnectionPromise) {
|
||||
this._mqttConnectionPromise = this.createMqttConnection().catch((err) => {
|
||||
this._mqttConnectionPromise = undefined;
|
||||
throw err;
|
||||
});
|
||||
}
|
||||
|
||||
return this._mqttConnectionPromise;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new MQTT connection using AWS IoT WebSocket connections with Cognito credentials.
|
||||
*
|
||||
* @returns A promise that resolves to an active MQTT connection.
|
||||
* @throws {@link Error} When connection establishment fails.
|
||||
*/
|
||||
private async createMqttConnection(): Promise<mqtt.MqttClientConnection> {
|
||||
const session = await this.getFreshSession();
|
||||
const credentialsProvider = fromCognitoIdentityPool({
|
||||
clientConfig: {
|
||||
@@ -407,18 +585,36 @@ export class MysaApiClient {
|
||||
|
||||
const config = builder.build();
|
||||
const client = new mqtt.MqttClient();
|
||||
this._mqttConnection = client.new_connection(config);
|
||||
const connection = client.new_connection(config);
|
||||
|
||||
this._mqttConnection.on('closed', () => {
|
||||
connection.on('connect', () => this._logger.debug('MQTT connect'));
|
||||
connection.on('connection_success', () => this._logger.debug('MQTT connection_success'));
|
||||
connection.on('connection_failure', (e) => this._logger.error('MQTT connection_failure', e));
|
||||
connection.on('interrupt', (e) => this._logger.warn('MQTT interrupt', e));
|
||||
connection.on('resume', (returnCode, sessionPresent) =>
|
||||
this._logger.info(`MQTT resume returnCode=${returnCode} sessionPresent=${sessionPresent}`)
|
||||
);
|
||||
connection.on('error', (e) => this._logger.error('MQTT error', e));
|
||||
|
||||
connection.on('closed', () => {
|
||||
this._logger.info('MQTT connection closed');
|
||||
this._mqttConnection = undefined;
|
||||
this._mqttConnectionPromise = undefined;
|
||||
});
|
||||
|
||||
await this._mqttConnection.connect();
|
||||
await connection.connect();
|
||||
|
||||
return this._mqttConnection;
|
||||
return connection;
|
||||
}
|
||||
|
||||
/**
|
||||
* Processes incoming MQTT messages and emits appropriate events.
|
||||
*
|
||||
* This method parses MQTT payloads and converts them into typed events that can be listened to via the client's event
|
||||
* emitter. It handles both v1 and v2 device message formats and emits events like 'statusChanged', 'setPointChanged',
|
||||
* and 'stateChanged'.
|
||||
*
|
||||
* @param payload - The raw MQTT message payload to process.
|
||||
*/
|
||||
private processMqttMessage(payload: ArrayBuffer) {
|
||||
try {
|
||||
const parsedPayload = parseMqttPayload(payload);
|
||||
|
||||
@@ -32,7 +32,7 @@ export function parseMqttPayload(payload: ArrayBuffer): OutPayload {
|
||||
* @param payload - The typed payload object to serialize
|
||||
* @returns The serialized payload as ArrayBuffer ready for MQTT transmission
|
||||
*/
|
||||
export function serializeMqttPayload<T extends InPayload>(payload: T): ArrayBuffer {
|
||||
export function serializeMqttPayload<T extends InPayload>(payload: T): Uint8Array<ArrayBuffer> {
|
||||
const jsonString = JSON.stringify(payload);
|
||||
const encoder = new TextEncoder();
|
||||
return encoder.encode(jsonString);
|
||||
|
||||
Reference in New Issue
Block a user