Eleon S1 MQTT Consumer API Definition 1.1.0

The MQTT consumer API to access Eleon S1 provided elevator information and states

  • #elevator
  • #monitoring
  • #maintenance

Servers

  • mqtt.eleon.elfin.demqtt 3.1.1production

Operations

  • SUB /{eleonId}/meta

    Operation IDsubscribe

    Available only on servers:

    object
    eleonId
    required
    string
    • #Meta Information

    Accepts the following message:

    MetaInformationMessage
    Message IDMetaInformationMessage

    Holds the meta information for the installation location of the Eleon S1 device identified by {eleonId}.

    object

    An info object holding the meta information available for the associated eleon S1 device

    object

    Examples

  • SUB /{eleonId}/connected-to-controller

    Operation IDsubscribe

    Available only on servers:

    object
    eleonId
    required
    string
    • #Meta Information

    Accepts the following message:

    ConnectedToControllerMessage
    Message IDConnectedToControllerMessage

    Holds the information if the Eleon S1 device identified by {eleonId} is (still) connected to the controller.

    allOf

    A payload object holding an integer value

    object

    Examples

  • SUB /{eleonId}/elevator/information/current-floor/absolute

    Operation IDsubscribe

    Available only on servers:

    object
    eleonId
    required
    string
    • #Elevator Information

    Accepts the following message:

    ElevatorCurrentFloorAbsoluteMessage
    Message IDElevatorCurrentFloorAbsoluteMessage

    Holds the current floor position of the elevator the eleon S1 identified by {eleonId} is installed in as an index counting from 1 as the lowest floor (compare).

    allOf

    A payload object holding an integer value

    object

    Examples

  • SUB /{eleonId}/elevator/information/current-floor/relative

    Operation IDsubscribe

    Available only on servers:

    object
    eleonId
    required
    string
    • #Elevator Information

    Accepts the following message:

    ElevatorCurrentFloorRelativeMessage
    Message IDElevatorCurrentFloorRelativeMessage

    Holds the current floor position of the elevator the eleon S1 identified by {eleonId} is installed in as a number relative to the ground floor as 0 (compare).

    allOf

    A payload object holding an integer value

    object

    Examples

  • SUB /{eleonId}/elevator/information/moving

    Operation IDsubscribe

    Available only on servers:

    object
    eleonId
    required
    string
    • #Elevator Information

    Accepts the following message:

    ElevatorMovingMessage
    Message IDElevatorMovingMessage

    Holds the information if the elevator the eleon S1 identified by {eleonId} is installed in is currently moving.

    allOf

    A payload object holding an integer value

    object

    Examples

  • SUB /{eleonId}/elevator/information/door/{doorId}/status

    Operation IDsubscribe

    Available only on servers:

    object
    eleonId
    required
    string
    doorId
    required
    integer
    • #Elevator Information

    Accepts the following message:

    ElevatorDoorStatusMessage
    Message IDElevatorDoorStatusMessage

    A message showing the current door state of the door identified by {doorId} of the elevator car the eleon S1 identified by {eleonId} is installed in.

    allOf
    object

    Examples

  • SUB /{eleonId}/elevator/information/safety-chain-closed

    Operation IDsubscribe

    Available only on servers:

    object
    eleonId
    required
    string
    • #Elevator Information

    Accepts the following message:

    ElevatorSafetyCircuitMessage
    Message IDElevatorSafetyCircuitMessage

    Holds the information if the safety chain of elevator the eleon S1 identified by {eleonId} is installed in is currently closed.

    allOf

    A payload object holding an integer value

    object

    Examples

  • SUB /{eleonId}/alarm/error

    Operation IDsubscribe

    Available only on servers:

    object
    eleonId
    required
    string
    • #Alarm

    Accepts the following message:

    AlarmErrorMessage
    Message IDAlarmErrorMessage

    A message holding the error information state of the elevator the eleon S1 identified by {eleonId} is installed in.

    allOf

    A payload object describing an error state

    object

    Examples

  • SUB /{eleonId}/alarm/status

    Operation IDsubscribe

    Available only on servers:

    object
    eleonId
    required
    string
    • #Alarm

    Accepts the following message:

    AlarmStatusMessage
    Message IDAlarmStatusMessage

    A message holding information about the status of the elevator the eleon S1 identified by {eleonId} is installed in.

    allOf

    A payload object describing an elevator state

    object

    Examples

  • SUB /{eleonId}/elevator/kpi/floor-stops/absolute/{absoluteFloorNumber}

    Operation IDsubscribe

    Available only on servers:

    object
    eleonId
    required
    string
    absoluteFloorNumber
    required
    integer
    format: uint32
    • #Elevator Key Performance Indicators

    Accepts the following message:

    ElevatorKpiFloorStopsAbsoluteMessage
    Message IDElevatorKpiFloorStopsAbsoluteMessage

    Holds the amount of stops of the elevator the eleon S1 identified by {eleonId} is installed in stopped at the floor identified by {absoluteFloorNumber}. Where floor number is an index counting from 1 as the lowest floor.

    allOf

    A payload object holding an unsigned integer value

    object

    Examples

  • SUB /{eleonId}/elevator/kpi/floor-stops/relative/{relativeFloorNumber}

    Operation IDsubscribe

    Available only on servers:

    object
    eleonId
    required
    string
    relativeFloorNumber
    required
    integer
    format: int32
    • #Elevator Key Performance Indicators

    Accepts the following message:

    ElevatorKpiFloorStopsRelativeMessage
    Message IDElevatorKpiFloorStopsRelativeMessage

    Holds the amount of stops of the elevator the eleon S1 identified by {eleonId} is installed in stopped at the floor identified by {relativeFloorNumber}. Where floor number is an number relative to the ground floor.

    allOf

    A payload object holding an unsigned integer value

    object

    Examples

  • SUB /{eleonId}/elevator/kpi/ride-counter/{interval}

    Operation IDsubscribe

    Available only on servers:

    object
    eleonId
    required
    string
    interval
    required
    string
      Allowed values:
    • "hour"
    • "day"
    • "month"
    • "maintenance"
    • #Elevator Key Performance Indicators

    Accepts the following message:

    ElevatorKpiRideCounterMessage
    Message IDElevatorKpiRideCounterMessage

    Holds the amount of rides the elevator the eleon S1 identified by {eleonId} is installed in performed.

    allOf

    A payload object holding an unsigned integer value

    object

    Examples

Schemas

  • RelativeFloorNumber
    integer
    format: int32

    An integer value describing a floor relative to a ground floor identified by 0. This means sublevels are negative values, levels above ground floor are positive.

  • AbsoluteFloorNumber
    integer
    format: uint32

    An integer value describing a floor as a one based index. Where 1 ist the lowest floor in the building

  • object

    An info object holding the meta information available for the associated eleon S1 device

  • allOf

    A payload object holding an integer value

  • allOf

    A payload object holding an unsigned integer value

  • object

    The available door states

    • 0: Closed
    • 1: Opening
    • 2: Opened
    • 3: Closing
  • allOf

    A payload object holding an integer value

  • allOf

    A payload object describing an error state

  • allOf

    A payload object describing an elevator state

  • object

    A base data structure for timestamped payloads