• Αρχική
  • API 2 – Λογισμικό διαχείρισης έξυπνων κάδων

API 2 – Λογισμικό διαχείρισης έξυπνων κάδων

Επιστροφή

Data

Bins area Item

Represents the bins collection place, an area where smart bins are located. Must have class set to BinsArea and type set to Zone.

Item metadata

There are no specific metadata for this Item.

Smart bin Item

Represents smart garbage bin, a waste bin collecting different types of garbage. Must have class set to SmartBin and type to Container.

Item metadata

{
  "type": "Paper",
  "provider": {
    "name": "Operator Ltd.",
    "contact": "Phone 577 100 589"
  },
  "volume": 200
}

Where:

  • type Garbage type (Residual, Organic, Paper, Metal, Glass, ColorGlass, WhiteGlass, Electronic or Plastic)
  • provider Provider information
  • provider.name Provider name
  • provider.contact Provider phone number or email address
  • volume Bin volume (in liters)

Garbage data

Current level of garbage inside the bin. Stored in Item under the garbage data key.

{
  "level": 25
}

Where:

  • level Garbage level (in percentage – 0 is empty, 100 is full)

Collection data

Last known date of garbage collection. Stored under collection data key.

{
  "timestamp": "2017-14-25T19:45:07.000Z",
  "levelBefore": 98,
  "levelAfter": 15
}

Where:

  • timestamp Date and time of bin collection
  • levelBefore Garbage level before collection (in percentage – 0 is empty, 100 is full)
  • levelAfter Garbage level after collection (in percentage – 0 is empty, 100 is full)

Door data

Door status. Stored in Item under the door data key.

{
  "status": "Open"
}

Where:

  • status Door status (Open, Closed or Jam)

Bin garbage sensor Item

Represents smart bin sensor measuring garbage level inside the bin. Must have parent of SmartBin Item. Must have class set to BinGarbageSensor and type set to Device.

Item metadata

There are no specific metadata for this Item.

Garbage data

Current level of garbage measured. Stored in Item under the garbage data key.

{
  "level": 25
}

Where:

  • level Garbage level (in percentage – 0 is empty, 100 is full)

Collection data

Last known date of garbage collection. Stored under collection data key.

{
  "timestamp": "2017-14-25T19:45:07.000Z",
  "levelBefore": 98,
  "levelAfter": 15
}

Where:

  • timestamp Date and time of bin collection
  • levelBefore Garbage level before collection (in percentage – 0 is empty, 100 is full)
  • levelAfter Garbage level after collection (in percentage – 0 is empty, 100 is full)

Bin door sensor Item

Represents door sensor detecting door status inside the bin. Must have parent of SmartBin Item. Must have class set to BinDoorSensor and type set to Device.

Item metadata

There are no specific metadata for this Item.

Door data

Door status. Stored in Item under the door data key.

{
  "status": "Open"
}

Where:

  • status Door status (Open, Closed or Jam)

Events

BinGarbageLevelChangedEvent

Shall be registered whenever bin garbage level has changed.

Event extras

{
  "level": 50
}

Where:

  • level New garbage level (in percentage – 0 is empty, 100 is full)

BinGarbageCollectedEvent

Shall be registered after garbage collection.

Event extras

{
  "levelBefore": 98,
  "levelAfter": 15
}

Where:

  • levelBefore Garbage level before collection (in percentage – 0 is empty, 100 is full)
  • levelAfter Garbage level after collection (in percentage – 0 is empty, 100 is full)

BinDoorStatusChangedEvent

Shall be registered each time door sensor detects new door status.

Event extras

{
  "status": "Jam"
}

Where:

  • status Door status (Open, Closed or Jam)