Simple.AMT 0.4.0

dotnet add package Simple.AMT --version 0.4.0
NuGet\Install-Package Simple.AMT -Version 0.4.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Simple.AMT" Version="0.4.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Simple.AMT --version 0.4.0
#r "nuget: Simple.AMT, 0.4.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Simple.AMT as a Cake Addin
#addin nuget:?package=Simple.AMT&version=0.4.0

// Install Simple.AMT as a Cake Tool
#tool nuget:?package=Simple.AMT&version=0.4.0

Intelbras AMT Monitor

NuGet

[EN]

This project started as a study of the communication protocol used by the Intelbras AMT-8000 alarm system, which lacks proper documentation.

The project is based on the captured packets using WireShark.

[PT-BR]

Este projeto começou para estudar a comunicação do alarme Intelbras AMT-8000 que tem uma documentação inexistente

O projeto é baseado nos pacotes capturados com WireShark

This project was not intended for production use; however, the testing tools may be helpful in some cases.

The AMT.App project can be used interactively or in CLI mode.

AMT.App Usage options

Available Operation Modes

This application supports multiple interactions modes

To list all available options, use --help or /h

Global Parameters

  • --help or /h: Displays the help information for the available commands.
  • --ip: Specifies the central IP address.
  • --port: Specifies the central port number.
  • --pwd: Specifies the central password.

Usage

To execute any command, you can include it as an argument when running the application.

Example usage:

$ AMT.App.exe --cli

This command will start the application in CLI mode.

$ AMT.App.exe --ip 192.168.0.1 --port 8080 --pwd myPassword

This command will launch the application and connect to the central server using the specified IP address, port number, and password.

Please note that only the --cli command is available in the command-line interface mode, while the other commands can be used in both CLI and listen modes.

CLI Mode

A very crude CLI based way of requesting information

Mostly used for debugging

Parameters:

  • --cli: activates CLI mode
  • --max-sensors: max sensors to display
  • --central-info: outputs central information
  • --update: continuously print changed sensors
  • --continuous: continuously print sensors values (easy to parse)

JSON Mode

Prints specific information as json

Parameters:

  • --json: activates JSON mode
  • --central-info: fetch central data
  • --central-mac: fetch central mac"
  • --zone-names: fetch zone names
  • --zone-types: fetch zone types
  • --sensors-config: fetch sensors configuration
  • --sensors: fetch sensors states
  • --users: fetch sensors states
  • --connections: fetch connections states
  • --events: fetch central events

Using with Docker

Using this project inside a docker container

  1. Save this Dockerfile to a directory:
# Dockerfile

# Base image with .NET SDK 6.0
FROM mcr.microsoft.com/dotnet/sdk:6.0 AS build-env

# Set the working directory
WORKDIR /app

# Clone this repository
RUN git clone https://github.com/RafaelEstevamReis/AMT-Monitor.git

# Change directory to the cloned repository
WORKDIR /app/AMT-Monitor

# Build the project
RUN dotnet build -c Release

# Run the project
CMD ["dotnet", "run", "--project", "AMT.App/AMT.App.csproj"]
  1. Build the Docker image using the following command:
docker build -t amt-monitor .
  1. After the image is successfully built, you can run a container based on the image:
docker run -it amt-monitor [execution arguments]

Replace [execution arguments] with the desired arguments such as --cli, --ip, or any other applicable arguments based on the project's command-line options.

Note that:

  1. You have to provide all needed parameters:
  • IP
  • Password

And may need to provide

  • Port
  1. This must run from the same network as the AMT, cloud access is not supported

WebApp / API Usage options

To install the API on a Linux machine or in a proxmox LXC:

  1. Create the VM/Container, and install docker
  2. Open the VM console
  3. Paste this line to download the script and run curl -sSL -o install.sh https://raw.githubusercontent.com/RafaelEstevamReis/AMT-Monitor/main/AMT.API/install.sh && bash install.sh
  4. Fill the Central IP and MAC
  5. After the complete, go to http://<IP>/swagger/index.html

Contributing

We welcome contributions to the project! However, it's important to note that none of Intelbras' intellectual property (IP), including their proprietary code, algorithms, or documentation, should be used or included in any contributions.

Please adhere to the following guidelines when making contributions:

  1. Respect Intellectual Property: Do not use or include any Intelbras IP in your contributions. This includes code snippets, algorithms, documentation, or any other proprietary information owned by Intelbras.

  2. Original Work: Ensure that your contributions are your original work and do not infringe upon any intellectual property rights of others.

  3. License Compatibility: Make sure that your contributions are compatible with the project's open-source license, if applicable.

Please be aware that contributions that violate these guidelines, including those that contain any Intelbras IP, will not be accepted. If, by any chance, such contributions are mistakenly accepted, they will be promptly identified and removed from the project. We genuinely appreciate your understanding and cooperation in assisting us in maintaining a compliant and respectful project environment.

Additionally, we want to emphasize that individuals who have signed any non-disclosure agreements (NDAs) with Intelbras or have had access to Intelbras software development kits (SDKs) are not permitted to contribute to this project's library. We must respect legal obligations and protect intellectual property rights. If you fall into this category, we kindly request that you refrain from making this contributions. Thank you for your understanding and adherence to this policy.

If you have any questions or need further clarification, please reach out to the project maintainers. Thank you for your interest in contributing to the project!

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.1

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.4.0 173 7/15/2023
0.3.1 190 6/26/2023
0.2.2 126 6/20/2023
0.2.1 220 2/21/2023
0.2.0 418 7/28/2022
0.1.2 414 7/28/2022
0.1.1 373 7/28/2022
0.1.0 383 7/28/2022

Paired with commit 80efef6