Skip to content

services.md

Latest commit

 

History

History
270 lines (247 loc) · 4.79 KB

services.md

File metadata and controls

270 lines (247 loc) · 4.79 KB

Service specifications for the Rest-API and WebSockets

API

  • base url: localhost:4000/api

Routines

POST /api/routines/stop

Stops the currenlty running routine. Response:

200 {}
POST /api/routines/start

Request:

{
  "id": 10,
}

Response:

200 {
  "data": {
    "id": 10,
    "title": "title",
    "strain": "strain",
    "medium": "medium",
    "target_temp": "target_temp",
    "target_ph": "target_ph",
    "target_co2": "target_co2",
    "target_density": "target_density",
    "estimated_time_seconds": "estimated_time_seconds",
    "extra_notes": "extra_notes",
    "inserted_at": "inserted_at",
    "updated_at": "updated_at",
  }
}

422 {"errors": []}
GET /api/routines

Response:

200 {
  "data": [{
    "id": 10,
    "title": "title",
    "strain": "strain",
    "medium": "medium",
    "target_temp": "target_temp",
    "target_ph": "target_ph",
    "target_co2": "target_co2",
    "target_density": "target_density",
    "estimated_time_seconds": "estimated_time_seconds",
    "extra_notes": "extra_notes",
    "inserted_at": "inserted_at",
    "updated_at": "updated_at",
  }]
}

422 {"errors": []}
GET /api/routines/:id
POST /api/routines

Creates and starts a new routine. It fails if there is a routine already started. Response:

200 {
  "data": {
    "id": 10,
    "title": "title",
    "strain": "strain",
    "medium": "medium",
    "target_temp": "target_temp",
    "target_ph": "target_ph",
    "target_co2": "target_co2",
    "target_density": "target_density",
    "estimated_time_seconds": "estimated_time_seconds",
    "extra_notes": "extra_notes",
    "inserted_at": "inserted_at",
    "updated_at": "updated_at",
  }
}

422 {"errors": []}
PUT /api/routines/:id

Updates a routine Response:

200 {
  "data": {
    "id": 10,
    "title": "title",
    "strain": "strain",
    "medium": "medium",
    "target_temp": "target_temp",
    "target_ph": "target_ph",
    "target_co2": "target_co2",
    "target_density": "target_density",
    "estimated_time_seconds": "estimated_time_seconds",
    "extra_notes": "extra_notes",
    "inserted_at": "inserted_at",
    "updated_at": "updated_at",
  }
}

422 {"errors": []}
DELETE /api/routines/:id

Deletes a routine Response:

200 {}

500 {}

Readings

GET /api/routines/:routine_id/readings

Response:

200 {
  "data": [{
    "id": 10,
    "temp": "temp",
    "ph": "ph",
    "co2": "co2",
    "density": "density",
    "routine_id": "routine_id"
    }]
  }
GET /api/routines/:routine_id/readings/:id

Response:

200 {
  "data": {
    "id": 10,
    "temp": "temp",
    "ph": "ph",
    "co2": "co2",
    "density": "density",
    "routine_id": "routine_id"
    }
  }
DELETE /api/routines/:routine_id/readings/:id

Response:

200 {}

500 {}

PH

GET api/ph/current

Response

  {
    "current_value": "7.2"
  }
GET api/ph/status

RETURNS THE STATUS OF THE LAST CALIBRATION STARTED Response

  {
    calibration_target: (4 | 7 | 10),
    calibration_status: (ok, started, error, not_started)
  }
POST api/ph/base

SETS THE BASE CONFIG ON THE SENSOR, RETURNS THAT VALUE (NOT FOR USE, JUST TO SEND IT) BODY

{}

Response

{
  "message": "Comenzó la calibración, no quite el sensor de la solución"
}
POST api/ph/acid

SETS THE ACID CONFIG ON THE SENSOR, RETURNS THAT VALUE (NOT FOR USE, JUST TO SEND IT) BODY

{}

Response

{
  "message": "Comenzó la calibración, no quite el sensor de la solución"
}
POST api/ph/neutral

SETS THE NEUTRAL CONFIG ON THE SENSOR, RETURNS THAT VALUE (NOT FOR USE, JUST TO SEND IT) BODY

{}

Response

{
  "message": "Comenzó la calibración, no quite el sensor de la solución"
}

Socket

  • Base url: localhost:4000/socket
  • Topic: routine
  • Events: update | start | stop | alert

Events

Start

Called when the routine starts

  • Event: start
  • Payload:
  {"id": "routine.id", "target_temp": "routine.target_temp"}
Stop

Called when the routine stops

  • Event: stop
  • Payload:
  {"id": "routine.id", "target_temp": "routine.target_temp"}
Update

Called when a new reading is recorded

  • Event: update
  • Payload:
  {"id": "routine.id", "temp": "reading.temp"}
Alert

Called when an alert is issued after processing a reading

  • Event: start
  • Payload:
  {"message": "message", "errors": ["error1", "errorN"]}

Sensors

status

Called when the sensor status is checked

  • Event: status
  • Payload:
  {"temp": "temp"}
error

Called when there is an error with the sensors

  • Event: error
  • Payload:
  {"message": "message"}