Centiloc Service Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Core.evttest

core.evttest is designed to support developers working with Centiloc products and Centiloc software. It allows generating events the exact same way as Centiloc boards, thus demonstrating the reaction of the software to these events.

Pre requesite

As the messages of core.evttest go through the same path and filters as real board messages, the BoardSN and UID used for calls to any methods of the API, must exist in Centiloc software and be legitimate for the user usage.

Using api-geo Board and Item services, you can retrieve quickly the SerialNumber and UID available.

Limitation

The endpoints described here are designed for end-use development. They are not sized for qualification tests, such as loading tests, performance tests.

The core.evttest services are only available for few ticks per minutes. After that you will get 429 HTTP error

Endpoints

Geo is the only service in core.evttest. It defines 2 methods:

  • MoveItem and OutItem allowing single movement of an item (UID) respectively on a surface and out of a surface.
    • Calling successived MoveItem reproduces the movement of an item sliding on a surface without leaving it
  • InitBoardContent setting a board up, with a new composition of items.

InitBoardContent is the only endpoint allowing multiple item management on a board. Other are for individual move, the same way as a board manages its items.

Table of contents

Geo

Geo is the service used to simulate geolocalisation of items on a board.

Method Name Request Type Response Type Description
InitBoardContent BoardContent .google.protobuf.Empty InitBoardContent simulates an initial board’s content (items).
MoveItem ItemMoveEvent .google.protobuf.Empty MoveItem simulates an item’s move on a board.
OutItem ItemOutEvent .google.protobuf.Empty OutItem simulates an item’s out from a board.

BoardContent

Field Type Label Description
board_sn string board where the items are geolocalised
items_position ItemPosition repeated list of items’ position

ItemMoveEvent

Field Type Label Description
board_sn string board where the item has moved
item_position ItemPosition an item has moved on a new position

ItemOutEvent

Field Type Label Description
board_sn string board where the item has been out
uid string identifier of the outgoing item

ItemPosition

Field Type Label Description
uid string identifier of the item targeted
pos_x_mm int32 X coordinate in millimeter of the item if is_in is true, otherwise 0
pos_y_mm int32 same as X, but with Y coordinate