---
alias: user-guide-oib-extensions-linecontrol
tags:
- connect iot
description: "This module manages line operations, enabling commands for status and recipe retrieval"
---

# Line Control

This module is responsible for controlling the line. It enables the user to perform a set of commands to request information or send controls to the line.

### Communication Parameters

| Name       | Type | Possible Values          | Default Value | Description                                                  |
| ---------- | ---- | ------------------------ | ------------- | ------------------------------------------------------------ |
| enableMode | Enum | ``None`<br> `OnePerLine` | `None`        | How to enable Line Control Module to connect to all defined lines.`None` - No instance will be used `OnePerLine` - One Instance per Line |

### Commands

#### LineControl.Command.GetRecipeForStation

This command will give you the recipe for a particular station, by lane.

| Command Parameter Name | Type   | Mandatory | Possible Values | Default Value | Description         |
| ---------------------- | ------ | --------- | --------------- | ------------- | ------------------- |
| LineName               | String | Yes       |                 |               | Line Full Path      |
| StationName            | String | Yes       |                 |               | Name of the station |

Example of a GetRecipeForStation reply as a JSON object:

```json
{
  "LineControl.Property.LeftConveyor.Recipe": "",
  "LineControl.Property.LeftConveyor.ProcessState": "Idle",
  "LineControl.Property.LeftConveyor.Board.Name": "",
  "LineControl.Property.LeftConveyor.Board.Side": "Undefined",
  "LineControl.Property.RightConveyor.Recipe": "Demo Recipes\\Recipe ASM Simple Product Board",
  "LineControl.Property.RightConveyor.ProcessState": "Processing",
  "LineControl.Property.RightConveyor.Board.Name": "Demo Boards\\ASM Simple Product Board",
  "LineControl.Property.RightConveyor.Board.Side": "Top"
}
```

#### LineControl.Command.GetLineStatus

This command will give you the status for a particular Line.

| Command Parameter Name | Type   | Mandatory | Possible Values | Default Value | Description    |
| ---------------------- | ------ | --------- | --------------- | ------------- | -------------- |
| LineName               | String | Yes       |                 |               | Line Full Path |

Example of a GetLineStatus reply as a JSON object:

```json
{
  "LineControl.Property.Line.Name": "Virtual Lines\\Virtual Line 01",
  "LineControl.Property.Job": null,
  "LineControl.Property.LineControlServer": "line01",
  "LineControl.Property.ProductionSchedule": "Demo Production Schedules\\Demo Production Schedule",
  "LineControl.Property.StationStatus": [
    {
      "LineControl.Property.Station.Name": "Virtual Stations\\Virtual SX4 01",
      "LineControl.Property.Setup.Name": "Demo Setups\\Virtual Line ASM Simple Product Board @ 19-10-07 07:52:24 [13556]",
      "LineControl.Property.ConnectionState": "Connected",
      "LineControl.Property.StationConveyorStatus": {
        "LineControl.Property.LeftConveyor.Recipe": "",
        "LineControl.Property.LeftConveyor.ProcessState": "Idle",
        "LineControl.Property.LeftConveyor.Board.Name": "",
        "LineControl.Property.LeftConveyor.Board.Side": "Undefined",
        "LineControl.Property.RightConveyor.Recipe": "Demo Recipes\\Recipe ASM Simple Product Board",
        "LineControl.Property.RightConveyor.ProcessState": "Processing",
        "LineControl.Property.RightConveyor.Board.Name": "Demo Boards\\ASM Simple Product Board",
        "LineControl.Property.RightConveyor.Board.Side": "Top"
      }
    }
  ]
}
```

#### LineControl.Command.StopStation

This command will give stop the given Station, this command has no expected reply.

| Command Parameter Name | Type   | Mandatory | Possible Values | Default Value | Description         |
| ---------------------- | ------ | --------- | --------------- | ------------- | ------------------- |
| LineName               | String | Yes       |                 |               | Line Full Path      |
| StationName            | String | Yes       |                 |               | Name of the station |