Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/basemax/grpcsmarthome

Welcome to the Smart Home Automation System project! This project aims to create a smart home automation system using gRPC for communication, allowing users to control and monitor devices such as lights, thermostats, and security cameras remotely.
https://github.com/basemax/grpcsmarthome

grpc home-smart javascript js light lights smart-home smarthome ts typescript

Last synced: 1 day ago
JSON representation

Host: GitHub
URL: https://github.com/basemax/grpcsmarthome
Owner: BaseMax
License: gpl-3.0
Created: 2023-08-16T05:40:05.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-09-30T17:12:37.000Z (4 months ago)
Last Synced: 2025-02-04T07:15:38.761Z (7 days ago)
Topics: grpc, home-smart, javascript, js, light, lights, smart-home, smarthome, ts, typescript
Language: TypeScript
Homepage:
Size: 1.89 MB
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Smart Home Automation System with gRPC (TypeScript)

## AuthService

The Auth Service handles user authentication and authorization. Methods:

- POST: `/auth/register` register user with correct credentials
- POST: `/auth/login` login to account
- **(available internally with grpc authService)** verifyToken: verify login user token

## HouseService

The House Service manage house data. Methods:

- POST: `/house` add your house
- PUT: `/house/:` update house data
- DELETE: `/house/:` remove your house data
- GET: `/house/:` see house status

## ThingService

The Thing Service manage and do interaction with things. Methods:

- Post: `/thing` add your thing to your house
- PUT: `/thing/:` update your thing data(just information)
- DELETE: `/thing/:` delete thing
- GET `/thing/:` get information about thing
- PATCH `/thing/:` have interaction with your thing here
- turn on
- turn off
- change mode
- increase level
- decrease level

# Demo

![demo](./screenshots/GRPCSMARTHOME.png)

### http requests from apigateway

![all requests](./screenshots/all_requests.png)

### grpc methods

![all grpc methods](./screenshots/grpc_all_requests.png)

### **AUTH HTTP end points**

![auth register](./screenshots/auth_register.png)
![auth login](./screenshots/auth_login.png)
![invalid token](./screenshots/invalid_token.png)

### **HOUSE HTTP end points**

![house add](./screenshots/house_create.png)
![house update](./screenshots/house_update.png)
![house delete](./screenshots/house_delete.png)
![house get](./screenshots/house_find.png)

### **THING HTTP end points**

![thing add](./screenshots/thing_create.png)
![thing update](./screenshots/thing_update.png)
![thing delete](./screenshots/thing_delete.png)
![thing get](./screenshots/thing_find.png)
![thing turn on](./screenshots/thing_action_turn_on.png)
![thing set auto](./screenshots/thing_set_auto.png)

## Features

- Control lights: Turn on/off lights remotely.
- Adjust thermostat: Set thermostat temperature remotely.
- Monitor security cameras: Access camera feeds remotely.

## Getting Started

### Prerequisites

- Node.js (v16 or higher)
- npm (Node Package Manager)

### Installation

**Clone the repository:**

```bash
git clone https://github.com/BaseMax/gRPCSmartHome.git
cd gRPCSmartHome
```

**Install dependencies:**

````bash
# Server
npm install

## Usage
**Start the server:**

```bash
# Inside the server directory
npm start:dev user
npm start:dev auth
npm start:dev house
npm start:dev thing
npm start:dev apigateway
````

## Functionality

### 1. Control Lights

Users can remotely control the lights in their smart home through the client application. The server communicates with the actual smart light devices and sends commands to turn the lights on or off based on user input.

### 2. Adjust Thermostat

The thermostat functionality allows users to set and adjust the temperature in their home using the client application. The gRPC service interacts with the thermostat devices to update the temperature settings and ensure optimal comfort.

### 3. Monitor Security Cameras

Users can access live camera feeds from their security cameras via the client application. The server fetches the camera data and streams it to the client, providing real-time visual updates of the designated areas.

### 4. Real-time Updates

The smart home automation system leverages gRPC's bidirectional streaming to provide real-time updates. This means that when a user interacts with the system (e.g., turns on a light), the server sends immediate feedback to the client, ensuring a responsive user experience.

### 5. User Authentication and Security

To ensure the security and privacy of the smart home, the project includes user authentication mechanisms. Only authorized users can access and control the devices in their home. Password protection and secure token management are implemented to safeguard user data.

### 6. Device Status Monitoring

The client application provides users with the ability to monitor the status of their devices. Users can check whether lights are on or off, view the current thermostat settings, and observe the activity captured by security cameras.

## Contributing

Contributions are welcome! If you'd like to contribute to the project, please fork the repository, create a feature branch, make your changes, and submit a pull request.

## License

This project is licensed under the GPL-3.0 License.