milesight-powermeter-api 0.0.2-0 → 2024.9.12

package/README.md

@@ -1,38 +1,43 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
-</p>
-
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
-
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
-<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
-<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
-<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
-    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+# Milesight Powermeter Api
 
 ## Description
 
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+The Milesight Powermeter API is an internal tool exclusively accessible to our backend team. It serves as a command hub for the Milesight CT10x powermeter using lorawan downlink commands.
 
-## Project setup
+## Requirements
+- RabbitMQ 3.9.11
+- Node 20.15.0
+
+## Installation
 
 ```bash
 $ npm install
 ```
 
-## Compile and run the project
+## Configuration
+
+- AWS_ACCESS_KEY_ID
+    -  AWS Access Key ID
+- AWS_SECRET_ACCESS_KEY
+    -  AWS Secret Key
+
+- NODE_ENV
+    - Node environment
+- LOG_LEVEL
+    - value can be debug, info, error and verbose.
+- MILESIGHT_POWERMETER_API_PORT
+    - configurable host port and has a default of `9059`
+
+- AMQP_HOST
+    - rabbitmq host
+- AMQP_USERNAME
+    - rabbitmq user
+- AMQP_PASSWORD
+    - rabbitmq password
+- AMQP_PORT
+    - rabbitmq port
+
+## Running the app
 
 ```bash
 # development
@@ -45,7 +50,7 @@ $ npm run start:dev
 $ npm run start:prod
 ```
 
-## Run tests
+## Test
 
 ```bash
 # unit tests
@@ -57,29 +62,27 @@ $ npm run test:e2e
 # test coverage
 $ npm run test:cov
 ```
+## REST API
 
-## Resources
-
-Check out a few resources that may come in handy when working with NestJS:
+### Get lorawan powermeter list
 
-- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
-- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
-- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
-- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
-- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
-- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
-- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
-
-## Support
+```
+GET powermeter/milesight
+```
 
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+`maxResult`(optional) range from 1-255 (default is 25)
+`nextToken`(optional) token for the succeeding page/request
 
-## Stay in touch
+### Reboot the powermeter
 
-- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
+```
+POST powermeter/milesight/reboot
 
-## License
+Body: {
+        deviceEui: string;
+        serialNumber?: string;
+      }
+```
+`deviceEui`(required) device eui of the milesight powermeter<br />
+`serialNumber`(optional) serial number of the milesight powermeter<br />
 
-Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).