milesight-powermeter-api 2024.9.13-0 → 2024.9.23

package/README.md

@@ -86,3 +86,18 @@ Body: {
 `deviceEui`(required) device eui of the milesight powermeter<br />
 `serialNumber`(optional) serial number of the milesight powermeter<br />
 
+### Set device interval for the powermeter
+
+```
+POST powermeter/milesight/interval
+
+Body: {
+        deviceEui: string;
+        serialNumber?: string;
+        interval: number;
+      }
+```
+`deviceEui`(required) device eui of the milesight powermeter<br />
+`serialNumber`(optional) serial number of the milesight powermeter<br />
+`interval`(required) interval value in minutes (1-1440)<br />
+

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "milesight-powermeter-api",
-  "version": "2024.9.13-0",
+  "version": "2024.9.23",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "milesight-powermeter-api",
-      "version": "2024.9.13-0",
+      "version": "2024.9.23",
       "license": "UNLICENSED",
       "dependencies": {
         "@coinspect/therma-action-rule-decoder": "2024.9.12",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "milesight-powermeter-api",
-  "version": "2024.9.13-0",
+  "version": "2024.9.23",
   "description": "Milesight Powermeter API is an internal tool accessible on backend. The API allows detail retrieval and command sending to its powermeters.",
   "author": "Lester Vitor",
   "license": "UNLICENSED",

package/src/controller/milesight.controller.spec.ts

@@ -98,4 +98,34 @@ describe('MilesightController', () => {
             expect(errorResult).toBeInstanceOf(HttpException);
         });
     });
+    describe('setDeviceInterval', () => {
+        const data = {
+            deviceEui: 'sampleDeviceEui',
+            serialNumber: 'sampleDeviceName',
+            interval: 1440,
+        };
+        it('should return result', async () => {
+            const controllerResult = {
+                message: `Successfully sent set device command for sampleDeviceEui.`,
+                result: true,
+            };
+            jest.spyOn(milesightService, 'setDeviceInterval').mockResolvedValue(
+                true,
+            );
+            const result = await milesightController.setDeviceInterval(data);
+            expect(result).toEqual(controllerResult);
+        });
+        it('should handle error properly', async () => {
+            jest.spyOn(milesightService, 'setDeviceInterval').mockResolvedValue(
+                null,
+            );
+            let errorResult = null;
+            try {
+                await milesightController.setDeviceInterval(data);
+            } catch (error) {
+                errorResult = error;
+            }
+            expect(errorResult).toBeInstanceOf(HttpException);
+        });
+    });
 });

package/src/controller/milesight.controller.ts

@@ -9,7 +9,11 @@ import {
     UsePipes,
     ValidationPipe,
 } from '@nestjs/common';
-import { DeviceListParamsDto, MilesightBaseDto } from '../dto/milesight.dto';
+import {
+    DeviceListParamsDto,
+    MilesightBaseDto,
+    MilesightSetIntervalDto,
+} from '../dto/milesight.dto';
 import { MilesightService } from '../service/milesight.service';
 import { AWSListThings } from '@coinspect/therma-action-rule-decoder';
 
@@ -58,4 +62,27 @@ export class MilesightController {
             result,
         };
     }
+
+    @Post('interval')
+    @UsePipes(new ValidationPipe())
+    async setDeviceInterval(
+        @Body() body: MilesightSetIntervalDto,
+    ): Promise<{ message: string; result: boolean }> {
+        const { deviceEui, serialNumber, interval } = body;
+        const result = await this.milesightService.setDeviceInterval(
+            deviceEui,
+            serialNumber ? serialNumber : deviceEui,
+            interval,
+        );
+        if (!result) {
+            throw new HttpException(
+                `Error occured rebooting device: ${deviceEui}`,
+                HttpStatus.INTERNAL_SERVER_ERROR,
+            );
+        }
+        return {
+            message: `Successfully sent set device command for ${deviceEui}.`,
+            result,
+        };
+    }
 }

package/src/dto/milesight.dto.ts

@@ -29,3 +29,12 @@ export class DeviceListParamsDto {
     @IsString()
     nextToken?: string;
 }
+
+export class MilesightSetIntervalDto extends MilesightBaseDto {
+    @IsNotEmpty()
+    @IsInt()
+    @Min(1)
+    @Max(1440)
+    @Type(() => Number)
+    interval: number;
+}

package/src/service/milesight.service.spec.ts

@@ -110,4 +110,33 @@ describe('MilesightService', () => {
             sendDownlinkSpy.mockClear();
         });
     });
+
+    describe('setDeviceInterval', () => {
+        const data = {
+            deviceEui: 'sampleDeviceEui',
+            serialNumber: 'sampleDeviceName',
+            interval: 1440,
+        };
+
+        it('should return true when downlink is successful', async () => {
+            const expectedDownlinkCommand = 'ff8e0005a0';
+            const sendDownlinkSpy = jest
+                .spyOn(downlinkService, 'sendDownlink')
+                .mockResolvedValue(true);
+            await milesightService.setDeviceInterval(
+                data.deviceEui,
+                data.serialNumber,
+                data.interval,
+            );
+            expect(sendDownlinkSpy).toHaveBeenCalledWith(
+                data.deviceEui,
+                data.serialNumber,
+                expectedDownlinkCommand,
+                'milesightPowermeterSetDeviceInterval',
+                85,
+                true,
+            );
+            sendDownlinkSpy.mockClear();
+        });
+    });
 });

package/src/service/milesight.service.ts

@@ -61,4 +61,35 @@ export class MilesightService {
             return null;
         }
     }
+
+    async setDeviceInterval(
+        deviceEui: string,
+        serialNumber: string,
+        interval: number,
+    ): Promise<boolean | null> {
+        try {
+            this.logger.log(
+                `Setting ${interval} minutes interval for device: ${deviceEui}`,
+            );
+            const hexString = interval.toString(16).padStart(4, '0');
+            const downlinkCommand = 'ff8e00' + hexString;
+            const response = await this.downlinkService.sendDownlink(
+                deviceEui,
+                serialNumber,
+                downlinkCommand,
+                'milesightPowermeterSetDeviceInterval',
+                fPort,
+                true,
+            );
+            this.logger.log(
+                `Successfully set device interval for ${deviceEui}`,
+            );
+            return response;
+        } catch (error) {
+            this.logger.error(
+                `Error setting device interval ${deviceEui}: ${error}`,
+            );
+            return null;
+        }
+    }
 }

package/timestamp.sh

@@ -1 +1 @@
-export DT=20240919115416
+export DT=20240926085218

package/src/app.controller.spec.ts

@@ -1,22 +0,0 @@
-import { Test, TestingModule } from '@nestjs/testing';
-import { AppController } from './app.controller';
-import { AppService } from './app.service';
-
-describe('AppController', () => {
-  let appController: AppController;
-
-  beforeEach(async () => {
-    const app: TestingModule = await Test.createTestingModule({
-      controllers: [AppController],
-      providers: [AppService],
-    }).compile();
-
-    appController = app.get<AppController>(AppController);
-  });
-
-  describe('root', () => {
-    it('should return "Hello World!"', () => {
-      expect(appController.getHello()).toBe('Hello World!');
-    });
-  });
-});

package/src/app.controller.ts

@@ -1,12 +0,0 @@
-import { Controller, Get } from '@nestjs/common';
-import { AppService } from './app.service';
-
-@Controller()
-export class AppController {
-  constructor(private readonly appService: AppService) {}
-
-  @Get()
-  getHello(): string {
-    return this.appService.getHello();
-  }
-}

package/src/app.module.ts

@@ -1,10 +0,0 @@
-import { Module } from '@nestjs/common';
-import { AppController } from './app.controller';
-import { AppService } from './app.service';
-
-@Module({
-  imports: [],
-  controllers: [AppController],
-  providers: [AppService],
-})
-export class AppModule {}

package/src/app.service.ts

@@ -1,8 +0,0 @@
-import { Injectable } from '@nestjs/common';
-
-@Injectable()
-export class AppService {
-  getHello(): string {
-    return 'Hello World!';
-  }
-}

package/test/app.e2e-spec.ts

@@ -1,24 +0,0 @@
-import { Test, TestingModule } from '@nestjs/testing';
-import { INestApplication } from '@nestjs/common';
-import * as request from 'supertest';
-import { AppModule } from './../src/app.module';
-
-describe('AppController (e2e)', () => {
-  let app: INestApplication;
-
-  beforeEach(async () => {
-    const moduleFixture: TestingModule = await Test.createTestingModule({
-      imports: [AppModule],
-    }).compile();
-
-    app = moduleFixture.createNestApplication();
-    await app.init();
-  });
-
-  it('/ (GET)', () => {
-    return request(app.getHttpServer())
-      .get('/')
-      .expect(200)
-      .expect('Hello World!');
-  });
-});