> For the complete documentation index, see [llms.txt](https://docs.twtg.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.twtg.io/docs/solidred-documentation/3.1/data-analytics-features/detail/machine-overview.md).

# Machine overview

The machine overview consists of 2 sections. The example in the following shows the different sections of the machine overview page.

<figure><img src="https://194951116-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg2ULfgI3D3mQDYeAY5ti%2Fuploads%2FyaNAy6c63WkFaOKGvAiL%2Fimage.png?alt=media&amp;token=151ed345-f9b7-466f-a01d-8b3f6b684a2b" alt=""><figcaption></figcaption></figure>

### 1. Machine information

The machine information consists of several attributes attached to the asset. The sections are presented in the following schematic.

<figure><img src="https://194951116-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg2ULfgI3D3mQDYeAY5ti%2Fuploads%2FII7vQmuZg8xGnYZ6Gdf3%2Fimage.png?alt=media&amp;token=d6594e1c-edf8-4be2-bd3f-a6fe67e5a197" alt=""><figcaption><p>Machine information segments</p></figcaption></figure>

* **Name:** name of the entity.
* **Description:** the entity's description can be edited by clicking on the icon that appears when hovering the section.
* **Annotation:**  here all annotations added are displayed. Hovering in the section will make an icon visible where the user can manage the annotations.&#x20;
* **Configuration**: clicking the gear icon allows the user to batch configure devices within the machine.
* **Edit**: clicking on the pencil icon allows the user to edit the entity's information.
* **Image**: here the asset's image is displayed. Hovering in the section will make icons appear where the user can delete, add, or expand the image.

### 2. Alarms

Alarms (or Alerts) related to the machine being displayed can be seen in this section of the machine overview. Interaction with this section is outlined in the following image:

<figure><img src="https://content.gitbook.com/content/g2ULfgI3D3mQDYeAY5ti/blobs/kFgCt7Oy42hplTO4Smri/image.png" alt=""><figcaption><p>Alarms interaction in the machine overview</p></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.twtg.io/docs/solidred-documentation/3.1/data-analytics-features/detail/machine-overview.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
