Merge pull request #13 from SyncrowIOT/create-devices-endpoint

Create devices endpoint
This commit is contained in:
Ammar Qaffaf
2024-03-13 07:25:32 -04:00
committed by GitHub
11 changed files with 632 additions and 0 deletions

View File

@ -7,6 +7,7 @@ import { UserModule } from './users/user.module';
import { HomeModule } from './home/home.module'; import { HomeModule } from './home/home.module';
import { RoomModule } from './room/room.module'; import { RoomModule } from './room/room.module';
import { GroupModule } from './group/group.module'; import { GroupModule } from './group/group.module';
import { DeviceModule } from './device/device.module';
@Module({ @Module({
imports: [ imports: [
ConfigModule.forRoot({ ConfigModule.forRoot({
@ -17,6 +18,7 @@ import { GroupModule } from './group/group.module';
HomeModule, HomeModule,
RoomModule, RoomModule,
GroupModule, GroupModule,
DeviceModule,
], ],
controllers: [AuthenticationController], controllers: [AuthenticationController],
}) })

View File

@ -0,0 +1,117 @@
import { DeviceService } from '../services/device.service';
import {
Body,
Controller,
Get,
Post,
UseGuards,
Query,
Param,
} from '@nestjs/common';
import { ApiTags, ApiBearerAuth } from '@nestjs/swagger';
import { JwtAuthGuard } from '../../../libs/common/src/guards/jwt.auth.guard';
import {
AddDeviceInGroupDto,
AddDeviceInRoomDto,
} from '../dtos/add.device.dto';
import {
GetDeviceByGroupIdDto,
GetDeviceByRoomIdDto,
} from '../dtos/get.device.dto';
import { ControlDeviceDto } from '../dtos/control.device.dto';
@ApiTags('Device Module')
@Controller({
version: '1',
path: 'device',
})
export class DeviceController {
constructor(private readonly deviceService: DeviceService) {}
@ApiBearerAuth()
@UseGuards(JwtAuthGuard)
@Get('room')
async getDevicesByRoomId(
@Query() getDeviceByRoomIdDto: GetDeviceByRoomIdDto,
) {
try {
return await this.deviceService.getDevicesByRoomId(getDeviceByRoomIdDto);
} catch (err) {
throw new Error(err);
}
}
@ApiBearerAuth()
@UseGuards(JwtAuthGuard)
@Get('group')
async getDevicesByGroupId(
@Query() getDeviceByGroupIdDto: GetDeviceByGroupIdDto,
) {
try {
return await this.deviceService.getDevicesByGroupId(
getDeviceByGroupIdDto,
);
} catch (err) {
throw new Error(err);
}
}
@ApiBearerAuth()
@UseGuards(JwtAuthGuard)
@Get(':deviceId')
async getDevicesByDeviceId(@Param('deviceId') deviceId: string) {
try {
return await this.deviceService.getDevicesByDeviceId(deviceId);
} catch (err) {
throw new Error(err);
}
}
@ApiBearerAuth()
@UseGuards(JwtAuthGuard)
@Get(':deviceId/functions')
async getDevicesInstructionByDeviceId(@Param('deviceId') deviceId: string) {
try {
return await this.deviceService.getDevicesInstructionByDeviceId(deviceId);
} catch (err) {
throw new Error(err);
}
}
@ApiBearerAuth()
@UseGuards(JwtAuthGuard)
@Get(':deviceId/functions/status')
async getDevicesInstructionStatus(@Param('deviceId') deviceId: string) {
try {
return await this.deviceService.getDevicesInstructionStatus(deviceId);
} catch (err) {
throw new Error(err);
}
}
@ApiBearerAuth()
@UseGuards(JwtAuthGuard)
@Post('room')
async addDeviceInRoom(@Body() addDeviceInRoomDto: AddDeviceInRoomDto) {
try {
return await this.deviceService.addDeviceInRoom(addDeviceInRoomDto);
} catch (err) {
throw new Error(err);
}
}
@ApiBearerAuth()
@UseGuards(JwtAuthGuard)
@Post('group')
async addDeviceInGroup(@Body() addDeviceInGroupDto: AddDeviceInGroupDto) {
try {
return await this.deviceService.addDeviceInGroup(addDeviceInGroupDto);
} catch (err) {
throw new Error(err);
}
}
@ApiBearerAuth()
@UseGuards(JwtAuthGuard)
@Post('control')
async controlDevice(@Body() controlDeviceDto: ControlDeviceDto) {
try {
return await this.deviceService.controlDevice(controlDeviceDto);
} catch (err) {
throw new Error(err);
}
}
}

View File

@ -0,0 +1 @@
export * from './device.controller';

View File

@ -0,0 +1,11 @@
import { Module } from '@nestjs/common';
import { DeviceService } from './services/device.service';
import { DeviceController } from './controllers/device.controller';
import { ConfigModule } from '@nestjs/config';
@Module({
imports: [ConfigModule],
controllers: [DeviceController],
providers: [DeviceService],
exports: [DeviceService],
})
export class DeviceModule {}

View File

@ -0,0 +1,45 @@
import { ApiProperty } from '@nestjs/swagger';
import { IsNotEmpty, IsString, IsNumberString } from 'class-validator';
export class AddDeviceInRoomDto {
@ApiProperty({
description: 'deviceId',
required: true,
})
@IsString()
@IsNotEmpty()
public deviceId: string;
@ApiProperty({
description: 'roomId',
required: true,
})
@IsNumberString()
@IsNotEmpty()
public roomId: string;
}
export class AddDeviceInGroupDto {
@ApiProperty({
description: 'deviceId',
required: true,
})
@IsString()
@IsNotEmpty()
public deviceId: string;
@ApiProperty({
description: 'homeId',
required: true,
})
@IsNumberString()
@IsNotEmpty()
public homeId: string;
@ApiProperty({
description: 'groupId',
required: true,
})
@IsNumberString()
@IsNotEmpty()
public groupId: string;
}

View File

@ -0,0 +1,26 @@
import { ApiProperty } from '@nestjs/swagger';
import { IsNotEmpty, IsString } from 'class-validator';
export class ControlDeviceDto {
@ApiProperty({
description: 'deviceId',
required: true,
})
@IsString()
@IsNotEmpty()
public deviceId: string;
@ApiProperty({
description: 'code',
required: true,
})
@IsString()
@IsNotEmpty()
public code: string;
@ApiProperty({
description: 'value',
required: true,
})
@IsNotEmpty()
public value: any;
}

View File

@ -0,0 +1,44 @@
import { ApiProperty } from '@nestjs/swagger';
import { IsNotEmpty, IsNumberString } from 'class-validator';
export class GetDeviceByRoomIdDto {
@ApiProperty({
description: 'roomId',
required: true,
})
@IsNumberString()
@IsNotEmpty()
public roomId: string;
@ApiProperty({
description: 'pageSize',
required: true,
})
@IsNumberString()
@IsNotEmpty()
public pageSize: number;
}
export class GetDeviceByGroupIdDto {
@ApiProperty({
description: 'groupId',
required: true,
})
@IsNumberString()
@IsNotEmpty()
public groupId: string;
@ApiProperty({
description: 'pageSize',
required: true,
})
@IsNumberString()
@IsNotEmpty()
public pageSize: number;
@ApiProperty({
description: 'pageNo',
required: true,
})
@IsNumberString()
@IsNotEmpty()
public pageNo: number;
}

3
src/device/dtos/index.ts Normal file
View File

@ -0,0 +1,3 @@
export * from './add.device.dto';
export * from './control.device.dto';
export * from './get.device.dto';

View File

@ -0,0 +1,44 @@
export class GetDeviceDetailsInterface {
result: object;
success: boolean;
msg: string;
}
export class GetDevicesByRoomIdInterface {
success: boolean;
msg: string;
result: [];
}
export class GetDevicesByGroupIdInterface {
success: boolean;
msg: string;
result: {
count: number;
data_list: [];
};
}
export class addDeviceInRoomInterface {
success: boolean;
msg: string;
result: boolean;
}
export class controlDeviceInterface {
success: boolean;
result: boolean;
msg: string;
}
export class GetDeviceDetailsFunctionsInterface {
result: {
category: string;
functions: [];
};
success: boolean;
msg: string;
}
export class GetDeviceDetailsFunctionsStatusInterface {
result: [{ id: string; status: [] }];
success: boolean;
msg: string;
}

View File

@ -0,0 +1,338 @@
import { Injectable, HttpException, HttpStatus } from '@nestjs/common';
import { TuyaContext } from '@tuya/tuya-connector-nodejs';
import { ConfigService } from '@nestjs/config';
import {
AddDeviceInGroupDto,
AddDeviceInRoomDto,
} from '../dtos/add.device.dto';
import {
GetDeviceDetailsFunctionsInterface,
GetDeviceDetailsFunctionsStatusInterface,
GetDeviceDetailsInterface,
GetDevicesByGroupIdInterface,
GetDevicesByRoomIdInterface,
addDeviceInRoomInterface,
controlDeviceInterface,
} from '../interfaces/get.device.interface';
import {
GetDeviceByGroupIdDto,
GetDeviceByRoomIdDto,
} from '../dtos/get.device.dto';
import { ControlDeviceDto } from '../dtos/control.device.dto';
@Injectable()
export class DeviceService {
private tuya: TuyaContext;
constructor(private readonly configService: ConfigService) {
const accessKey = this.configService.get<string>('auth-config.ACCESS_KEY');
const secretKey = this.configService.get<string>('auth-config.SECRET_KEY');
// const clientId = this.configService.get<string>('auth-config.CLIENT_ID');
this.tuya = new TuyaContext({
baseUrl: 'https://openapi.tuyaeu.com',
accessKey,
secretKey,
});
}
async getDevicesByRoomId(getDeviceByRoomIdDto: GetDeviceByRoomIdDto) {
try {
const response = await this.getDevicesByRoomIdTuya(getDeviceByRoomIdDto);
return {
success: response.success,
devices: response.result,
msg: response.msg,
};
} catch (error) {
throw new HttpException(
'Error fetching devices',
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
async getDevicesByRoomIdTuya(
getDeviceByRoomIdDto: GetDeviceByRoomIdDto,
): Promise<GetDevicesByRoomIdInterface> {
try {
const path = `/v2.0/cloud/thing/space/device`;
const response = await this.tuya.request({
method: 'GET',
path,
query: {
space_ids: getDeviceByRoomIdDto.roomId,
page_size: getDeviceByRoomIdDto.pageSize,
},
});
return response as GetDevicesByRoomIdInterface;
} catch (error) {
throw new HttpException(
'Error fetching devices ',
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
async getDevicesByGroupId(getDeviceByGroupIdDto: GetDeviceByGroupIdDto) {
try {
const response = await this.getDevicesByGroupIdTuya(
getDeviceByGroupIdDto,
);
return {
success: response.success,
devices: response.result.data_list,
count: response.result.count,
msg: response.msg,
};
} catch (error) {
throw new HttpException(
'Error fetching devices',
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
async getDevicesByGroupIdTuya(
getDeviceByGroupIdDto: GetDeviceByGroupIdDto,
): Promise<GetDevicesByGroupIdInterface> {
try {
const path = `/v2.0/cloud/thing/group`;
const response = await this.tuya.request({
method: 'GET',
path,
query: {
space_id: getDeviceByGroupIdDto.groupId,
page_size: getDeviceByGroupIdDto.pageSize,
page_no: getDeviceByGroupIdDto.pageNo,
},
});
return response as GetDevicesByGroupIdInterface;
} catch (error) {
throw new HttpException(
'Error fetching devices ',
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
async addDeviceInRoom(addDeviceInRoomDto: AddDeviceInRoomDto) {
const response = await this.addDeviceInRoomTuya(addDeviceInRoomDto);
if (response.success) {
return {
success: response.success,
result: response.result,
msg: response.msg,
};
} else {
throw new HttpException(
response.msg || 'Unknown error',
HttpStatus.BAD_REQUEST,
);
}
}
async addDeviceInRoomTuya(
addDeviceInRoomDto: AddDeviceInRoomDto,
): Promise<addDeviceInRoomInterface> {
try {
const path = `/v2.0/cloud/thing/${addDeviceInRoomDto.deviceId}/transfer`;
const response = await this.tuya.request({
method: 'POST',
path,
body: {
space_id: addDeviceInRoomDto.roomId,
},
});
return response as addDeviceInRoomInterface;
} catch (error) {
throw new HttpException(
'Error adding device',
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
async addDeviceInGroup(addDeviceInGroupDto: AddDeviceInGroupDto) {
const response = await this.addDeviceInGroupTuya(addDeviceInGroupDto);
if (response.success) {
return {
success: response.success,
result: response.result,
msg: response.msg,
};
} else {
throw new HttpException(
response.msg || 'Unknown error',
HttpStatus.BAD_REQUEST,
);
}
}
async addDeviceInGroupTuya(
addDeviceInGroupDto: AddDeviceInGroupDto,
): Promise<addDeviceInRoomInterface> {
try {
const path = `/v2.0/cloud/thing/group/${addDeviceInGroupDto.groupId}/device`;
const response = await this.tuya.request({
method: 'PUT',
path,
body: {
space_id: addDeviceInGroupDto.homeId,
device_ids: addDeviceInGroupDto.deviceId,
},
});
return response as addDeviceInRoomInterface;
} catch (error) {
throw new HttpException(
'Error adding device',
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
async controlDevice(controlDeviceDto: ControlDeviceDto) {
const response = await this.controlDeviceTuya(controlDeviceDto);
if (response.success) {
return response;
} else {
throw new HttpException(
response.msg || 'Unknown error',
HttpStatus.BAD_REQUEST,
);
}
}
async controlDeviceTuya(
controlDeviceDto: ControlDeviceDto,
): Promise<controlDeviceInterface> {
try {
const path = `/v1.0/iot-03/devices/${controlDeviceDto.deviceId}/commands`;
const response = await this.tuya.request({
method: 'POST',
path,
body: {
commands: [
{ code: controlDeviceDto.code, value: controlDeviceDto.value },
],
},
});
return response as controlDeviceInterface;
} catch (error) {
throw new HttpException(
'Error control device',
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
async getDevicesByDeviceId(deviceId: string) {
try {
const response = await this.getDevicesByDeviceIdTuya(deviceId);
return {
success: response.success,
result: response.result,
msg: response.msg,
};
} catch (error) {
throw new HttpException(
'Error fetching device',
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
async getDevicesByDeviceIdTuya(
deviceId: string,
): Promise<GetDeviceDetailsInterface> {
try {
const path = `/v1.1/iot-03/devices/${deviceId}`;
const response = await this.tuya.request({
method: 'GET',
path,
});
return response as GetDeviceDetailsInterface;
} catch (error) {
throw new HttpException(
'Error fetching device ',
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
async getDevicesInstructionByDeviceId(deviceId: string) {
try {
const response = await this.getDevicesInstructionByDeviceIdTuya(deviceId);
return {
success: response.success,
result: {
category: response.result.category,
function: response.result.functions,
},
msg: response.msg,
};
} catch (error) {
throw new HttpException(
'Error fetching device functions',
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
async getDevicesInstructionByDeviceIdTuya(
deviceId: string,
): Promise<GetDeviceDetailsFunctionsInterface> {
try {
const path = `/v1.0/iot-03/devices/${deviceId}/functions`;
const response = await this.tuya.request({
method: 'GET',
path,
});
return response as GetDeviceDetailsFunctionsInterface;
} catch (error) {
throw new HttpException(
'Error fetching device functions',
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
async getDevicesInstructionStatus(deviceId: string) {
try {
const response = await this.getDevicesInstructionStatusTuya(deviceId);
return {
result: response.result,
success: response.success,
msg: response.msg,
};
} catch (error) {
throw new HttpException(
'Error fetching device functions',
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
async getDevicesInstructionStatusTuya(
deviceId: string,
): Promise<GetDeviceDetailsFunctionsStatusInterface> {
try {
const path = `/v1.0/iot-03/devices/status`;
const response = await this.tuya.request({
method: 'GET',
path,
query: {
device_ids: deviceId,
},
});
return response as unknown as GetDeviceDetailsFunctionsStatusInterface;
} catch (error) {
throw new HttpException(
'Error fetching device functions',
HttpStatus.INTERNAL_SERVER_ERROR,
);
}
}
}

View File

@ -0,0 +1 @@
export * from './device.service';