Transtream

Transtream Data Model

This project contains the description of message generated out of Centiloc information system over the transfer MQTT (ask support team for MQTT access information).

It describes events collected, qualified and used by Centiloc.

Depending on your subscription, some field may be masked. Fields will still be present anyway.

Topic usage

4 topics are used, proposing different data formats:

centiloc/$tenant: protobuf message (legacy)
centiloc/$tenant/json/item/v1/update: json message
centiloc/$tenant/proto/board/v1/update: protobuf message
centiloc/$tenant/json/board/v1/update: json message

protobuf item move topic semantic is out dated but maintained for legacy applications.

JSON message

Item Update

You can collect the message formatted in JSON following the specification below:

{
  "momentum":           time.Time
  "uid":                string
  "is_in":              bool
  "pos_mm":             []int32
  "board_sn":           string
  "nb_hits":            int32
  "hold_time":          time.Duration
  "fill_ratio":         float32
  "product_reference":  string
  "shelf_sn":           string
  "furniture_sn":       string
  "pos_on_shelf_mm":    []int32
  "tenant":             string
  "loc_reference":      string
  "loc_labels":         []string
  "item_labels":        []string
  "pos_on_floor_mm":    []int32
  "floor":              int32
  "is_interpolated":    bool
  }

Board Update

Same for board update:

 {
	"Momentum":  time.Time
	"BoardSN":   string
	"Status":    string
	"FwVersion": string

	"LastConnectionDate":    time.Time
	"LastDisconnectionDate": time.Time
	"LastErrorDate":         time.Time
}

Protobuf message

transtream/boardstatus.proto
- Enums
  - BoardStatus
- Messages
  - BoardStatusEvent
transtream/move.proto
- Messages
  - ItemMoveEvent

BoardStatus

BoardStatus represents an change in board status.

Name	Number	Description
BOARDSTATUS_CONNECTED	0	Board is connected to the data platform
BOARDSTATUS_DISCONNECTED	1	Board is disconnected from the data platform
BOARDSTATUS_ONERROR	2	Board is on error. Please contact support
BOARDSTATUS_MAINTENANCE	3	Board is temporary unavailable for maintenance operation

BoardStatusEvent

BoardStatusEvent represents an change in board status.

Field	Type	Label	Description
momentum	google.protobuf.Timestamp		momentum of board status change
sn	string		board sn
fw_version	string		board firmware version
status	BoardStatus		board status (connected / disconnected)
labels	string	repeated	board labels
tenant	string		board tenant
last_connection_date	google.protobuf.Timestamp		momentum of last board connection
last_disconnection_date	google.protobuf.Timestamp		momentum of last board disconnection
last_error_date	google.protobuf.Timestamp		momentum of last board error

ItemMoveEvent

ItemMoveEvent represents an item’s move detected on a board.

Field	Type	Label	Description
momentum	google.protobuf.Timestamp		date of board event
uid	string		item identifier
is_in	bool		if true, the item has moved on the board, else the item has been removed from the board
pos_mm	int32	repeated	array of size 2: [0]=X and [1]=Y in millimeters
board_sn	string		identity board having detected the move
nb_hits	int32		stat for the item: number of outs
hold_time	google.protobuf.Duration		stat for the item: duration out of boards
fill_ratio	float		ratio of product filling, (value is -1 if the measure is not available)
product_reference	string		product reference linked to the item
shelf_sn	string		shelf where is the board
furniture_sn	string		furniture where is the shelf
pos_on_shelf_mm	int32	repeated	position on shelf in millimeters
tenant	string		owner of the item
loc_reference	string		the location reference from the client erp
loc_labels	string	repeated	the location labels
item_labels	string	repeated	labels from item
pos_on_floor_mm	int32	repeated	position in furniture. is equal to pos_on_shelf_mm in case the shelf is not included in a furniture
floor	int32		floor in furniture, in case of integration
is_interpolated	bool		true if the message is generated by the system