Giter VIP home page Giter VIP logo

device-management's Introduction

Device configuration service

This is a springboot serivce to activate the IoT devices to be available for sale.
The serice is using the getStaus and patch endpoints from the warehouse service to validate the device data before configuring the device.

Build and deploy the service

Prerequisites

  • Java8 and mvn commands installed in the system
  • Docker engine (optional)

Build and deploy

The service is developed as a Maven project. To build and start the service run the following command in the application main directory mvn clean install spring-boot:run There is a dockerFile supplied in the repository to run the service in a container docker build -t .

REST Interfaces

Base URLs:

iot-device-controller

activateDevice

POST /dcs/activate

Body parameter

{
  "serialNumber": "string"
}

Parameters

Name In Type Required Description
body body ActivateDeviceDto true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK ResponseDto
400 Bad Request Bad Request ResponseDto
404 Not Found Not Found ResponseDto
406 Not Acceptable Not Acceptable ResponseDto
500 Internal Server Error Internal Server Error ResponseDto
This operation does not require authentication

Schemas

ResponseDto

{
  "success": true,
  "message": "Device data is retrieved successfully",
  "data": {}
}

Properties

Name Type Required Restrictions Description
success boolean false none none
message string false none none
data object false none none

Enumerated Values

Property Value
message Device data is retrieved successfully
message Device data is patched successfully
message Device is activated successfully
message Device not found
message Data validation failed
message Request contains invalid data
message Technical failure occurred, Please contact support team
message User doesn't have the required permission level to perform this action

ActivateDeviceDto

{
  "serialNumber": "string"
}

Properties

Name Type Required Restrictions Description
serialNumber string false none none

device-management's People

Contributors

omarabaza avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.