Transport Trait

API Service: TransportApi

TransportAPI represents something that can transport something else between places. The transport will often be an elevator, but could be an escalator, conveyor etc.

Method	Request Type	Response Type	Description
GetTransport	GetTransportRequest	Transport
PullTransport	PullTransportRequest	PullTransportResponse stream

Info Service: TransportInfo

Method	Request Type	Response Type	Description
DescribeTransport	DescribeTransportRequest	TransportSupport

Transport

Transport describes the current state of the transport.

Field Name	Type	Description
actual_position	Transport.Location	The actual position the transport. As the transport is moving towards its next destination, this value may be updated with intermediate locations.
next_destinations	repeated Transport.Location	Optional. The next destination(s) the transport will stop at.
moving_direction	Transport.Direction	Optional. The primary direction the transport is moving. An escalator technically moves up/down and forwards, but the primary intention is to transport up/down.
load	float	Optional. The total amount of load being carried. The units this is measured in is implementation specific. See TransportSupport A zero value means there is no load, an omitted value means the load is unknown.
doors	repeated Transport.Door	Optional. The status of each the door(s) of the transport.
operating_mode	Transport.OperatingMode	Optional. The operating mode the transport is in.
faults	repeated Transport.Fault	Optional. A list of active fault signals being reported.
passenger_alarm	Transport.Alarm	Optional. The status of the passenger alarm button.
speed	float	Optional. The speed of the transport. Zero represents a stationary transport, omitted means the speed is unknown. This is the current speed of the transport, not the average or maximum speed etc., this value may change rapidly. Use TransportSupport to determine the units of speed.
supported_destinations	repeated Transport.Location	Optional. The destinations that are supported by the transport. These should be ordered logically and consistently depending on the transport device. i.e. For a linear transport, the first and last items in this list should be the termini.
active	Transport.Active	Optional. The active state of the transport. Note this is different to mode, as the transport can be in an active or inactive state in different modes.
payloads	repeated Transport.Payload	Optional. Payloads describes the entities that are currently being transported.
eta_to_next_destination	google.protobuf.Duration	Optional. The estimated time the transport will take to arrive at it's next destination.

Transport.Alarm

Field Name	Type	Description
state	Transport.Alarm.AlarmState	The state of the alarm button.
time	google.protobuf.Timestamp	Optional. The time the alarm entered its current state.

Transport.Alarm.AlarmState

Name	Number	Description
ALARM_STATE_UNSPECIFIED	0
UNACTIVATED	1
ACTIVATED	2

Transport.Fault

Field Name	Type	Description
fault_type	Transport.Fault.FaultType	The type of fault.
time	google.protobuf.Timestamp	Optional. The time the fault was detected.
description	string	Optional. The description of the fault.

Transport.Fault.FaultType

Name	Number	Description
FAULT_TYPE_UNSPECIFIED	0
CONTROLLER_FAULT	1
DRIVE_AND_MOTOR_FAULT	2
MECHANICAL_COMPONENT_FAULT	3
OVERSPEED_FAULT	4
POWER_SUPPLY_FAULT	5
SAFETY_DEVICE_FAULT	6
CONTROLLER_SUPPLY_FAULT	7
DRIVE_TEMPERATURE_EXCEEDED	8
COMB_PLATE_FAULT	9	A comb plate safety switch is activated.
GENERAL_FAULT	10
DOOR_FAULT	11
LEVELLING_FAULT	12
SAFETY_CIRCUIT_BREAK_FAULT	13
FAIL_TO_START	14
ALARM_BUTTON	15	A fault has been detected with the alarm button. This is not the same as an activated passenger alarm. Use the passenger_alarm field to indicate the alarm button has been activated.
DOOR_NOT_CLOSING	16
DOOR_NOT_OPENING	17
GOVERNOR_AND_SAFETY_GEAR_FAULT	18
LIFT_SHAFT_DEVICE_FAULT	19	The fault is related to a device inside the lift shaft
CAR_STOPPED_OUTSIDE_LANDING_ZONE	20
CALL_BUTTON_STUCK	21
SELF_TEST_FAILURE	22
RUNTIME_LIMIT_EXCEEDED	23	The lift did not reach the expected zone.
POSITION_LOST	24
LOAD_MEASUREMENT_FAULT	25	The car load measurement system is in a fault condition.
OVERCAPACITY	26

Transport.Journey

Journey describes the journey of the transport or payload. It will have a source and one or more destinations.

Field Name	Type	Description
start	Transport.Location	The starting point of the journey.
destinations	repeated Transport.Location	The destinations of the journey. These must be in chronological order of intended arrival time.
reason	string	Optional. The reason for the journey.
start_time	google.protobuf.Timestamp	Optional. The time the journey started.
estimated_arrival_time	google.protobuf.Timestamp	Optional. The time the journey is estimated to arrive.

Transport.Door

Field Name	Type	Description
title	string	Title/display name of the door; front, rear, etc.
deck	int32	If the transport has multiple decks, this is the deck the door is on. 0 is the lowest deck.
status	Transport.Door.DoorStatus	The status of the door.

Transport.Door.DoorStatus

Name	Number	Description
DOOR_STATUS_UNSPECIFIED	0
CLOSED	1
OPEN	2
OPENING	3
CLOSING	4
SAFETY_LOCKED	5	The door is safety locked.
LIMITED_OPENED	6	The door remains in a position that is not fully open or closed.

Transport.Location

Location describes a specific location within a site that this transport can stop at.

Field Name	Type	Description
id	string	The id of the location. This should be unique within the context of the transport.
title	string	The title of the location. e.g. 'Lobby', 'Floor 1', 'Car Park'.
description	string	Optional. Description of the location.
floor	string	Optional. The floor of the location.

Transport.Payload

Field Name	Type	Description
payload_id	string	The id of the payload. The id must be unique within the transport for the duration of the journey. i.e. there should not be two payloads with the same id in the same transport at the same time.
description	string	The description of the payload.
intended_journey	Transport.Journey	The journey the payload is intending to take.
actual_journey	Transport.Journey	The actual journey the payload has taken so far. Once the payload leaves the transport, the journey is considered complete. Iff the final destination in intended_journey is the same as the location where the payload leaves the transport, the journey is considered to have been completed successfully.
external_ids	map<string, string>	IDs holds external identifiers for the payload. For example, a parcel may have an ID assigned by a courier company, a person may have an ID assigned by one or more building access systems, but the transport itself may not know these IDs

Transport.Direction

Name	Number	Description
DIRECTION_UNSPECIFIED	0
NO_DIRECTION	1	i.e. the device is stationary and not moving in any direction.
UP	2
DOWN	3
IN	4
OUT	5
CLOCKWISE	6
ANTICLOCKWISE	7
FORWARD	8
BACKWARD	9
EAST	10
WEST	11
NORTH	12
SOUTH	13
LEFT	14	Left and right are relative to the intended forwards direction of the transport. If this is not known use SIDEWAYS.
RIGHT	15
SIDEWAYS	16

Transport.OperatingMode

Name	Number	Description
OPERATING_MODE_UNSPECIFIED	0
NORMAL	1
SERVICE_CONTROL	2	The transport is in service or inspection control.
FIREFIGHTER_CONTROL	3	The transport is under a firefighter transport or firefighting transport mode of control. This usually happens during a fire alarm when firemen are on the site.
OUT_OF_SERVICE	4
EMERGENCY_POWER	5	The transport is being operated by emergency power and may be in limited operation.
VIP_CONTROL	6	The transport will not respond to any instruction until the VIP has reached their destination.
EARTHQUAKE_OPERATION	7
FIRE_OPERATION	8
ATTENDANT_CONTROL	9	The transport is being manually operated by an attendant.
PARKING	10	The transport is manually or automatically parked at a predefined floor and will not provide any further service. This usually happens in a low traffic condition for the purpose of energy saving.
HOMING	11	The transport is returning to its home position, usually the lobby or ground floor.
CABINET_RECALL	12	Control of the transport is performed from a control panel in the control cabinet. The transport is not available for normal operation.
OCCUPANT_EVACUATION	13	The transport is under an occupant evacuation mode of control. This usually happens during a fire alarm when the transport is used for evacuation of occupants.
FREIGHT	14	The transport is operational but is reserved for the transportation of goods only.
FAILURE	15
REDUCED_SPEED	16
STORM_OPERATION	17
HIGH_WIND_OPERATION	18

Transport.Active

Name	Number	Description
ACTIVE_UNSPECIFIED	0
INACTIVE	1
ACTIVE	2

TransportSupport

Field Name	Type	Description
resource_support	smartcore.types.ResourceSupport	How a named device supports read/write/pull apis
load_unit	string	The unit associated with the load value, e.g. kg, % of maximum load.
max_load	int32	The maximum load the transport can carry, in kg, if known. This can be used to calculate the current load weight if the load is reported as a percentage of the maximum load.
speed_unit	string	The unit associated with the speed value, e.g. m/s, km/h.

GetTransportRequest

GetTransportRequest is used to request the current state of the transport.

Field Name	Type	Description
name	string
read_mask	google.protobuf.FieldMask

DescribeTransportRequest

Field Name	Type	Description
name	string

PullTransportRequest

Field Name	Type	Description
name	string
read_mask	google.protobuf.FieldMask
updates_only	bool

PullTransportResponse

Field Name	Type	Description
changes	repeated PullTransportResponse.Change

PullTransportResponse.Change

Field Name	Type	Description
name	string
change_time	google.protobuf.Timestamp
transport	Transport