Packages

routeros_api

0.3.0
0.3.0 0.2.0

Elixir client for MikroTik RouterOS binary API with connection pooling, telemetry, and helper functions. Supports RouterOS 6.x and 7.x with both MD5 and plain text authentication over TCP and TLS.

HexDocs

Current section

Files

Jump to
Readme
2 Versions
2 Dependencies
Dependants
Files
Activity
routeros_api CHANGELOG.md
Raw

CHANGELOG.md 

# Changelog



All notable changes to this project will be documented in this file.



The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).



## [Unreleased]



## [0.3.0] - 2025-12-09



### Added

- **Streaming API for Live Monitoring**

  - `RouterosApi.Stream` module for consuming continuous data streams

  - `RouterosApi.StreamConnection` GenServer for async socket handling

  - Support for commands like `/interface/monitor-traffic`

  - Elixir Stream integration via `Stream.resource/3`

  - Automatic cleanup on stream halt

  - Tag-based command identification for cancellation



- **Protocol Extensions**

  - `RouterosApi.Protocol.Streaming` module for streaming support

  - Partial buffer parsing for async data reception

  - `set_active_once/1` for socket mode switching

  - `close_socket/1` helper function



- **Stream Telemetry Events**

  - `[:routeros_api, :stream, :connect, :start|:stop|:exception]`

  - `[:routeros_api, :stream, :start]`

  - `[:routeros_api, :stream, :stop]` with duration and data count



- **New Error Types**

  - `:stream_cancelled` - Stream was cancelled

  - `:stream_error` - Error during stream processing



- **Response Module Enhancement**

  - `sentence_type/1` helper function



### Changed

- Made `Protocol.socket_send/2` and `Protocol.socket_recv/2` public

- Updated documentation with streaming examples

- **Fixed**: Stream messages now sent to consuming process, not the process that called `monitor/3`

  - Streams can now be safely passed between processes or consumed in Tasks

  - The stream command is deferred until the stream is first consumed



## [0.2.0] - 2025-01-16



### Added

- **Connection Pooling** with NimblePool

  - Configurable pool size

  - Automatic health checks

  - Connection recovery

  - Supervision support



- **Telemetry Integration**

  - Connection events (start, stop, exception)

  - Command events (start, stop, exception)

  - Pool events (checkout, checkin)

  - Rich metadata for monitoring



- **Helper Functions** (`RouterosApi.Helpers`)

  - `list_interfaces/1` - List all interfaces

  - `get_interface/2` - Get specific interface

  - `list_ip_addresses/1` - List IP addresses

  - `add_ip_address/3` - Add IP address

  - `remove_ip_address/2` - Remove IP address

  - `get_system_resource/1` - Get system information

  - `get_identity/1` - Get router identity

  - `set_identity/2` - Set router identity

  - `list_firewall_rules/1` - List firewall rules

  - `list_dhcp_leases/1` - List DHCP leases

  - `reboot/1` - Reboot router



- **RouterOS 7.x Support**

  - Plain text authentication for RouterOS 6.43+

  - Automatic fallback to MD5 for older versions

  - Tested with RouterOS 7.12.1



- **Comprehensive Testing**

  - 109 tests (all passing)

  - Integration tests with real router

  - SSL/TLS integration tests

  - Pool tests

  - Telemetry tests

  - Helper function tests



- **SSL/TLS Support**

  - Full TLS/SSL connection support

  - Self-signed certificate support

  - Tested with RouterOS 7.12.1 on port 8729

  - Connection pooling works with TLS

  - All helpers work over TLS



### Changed

- Enhanced error handling and reporting

- Improved documentation with more examples

- Updated README with pooling and telemetry examples

- More conservative versioning (0.2.0 instead of 1.0.0)



### Fixed

- Protocol length decoding for all byte ranges

- Reply sentence (!re) handling

- Authentication compatibility with RouterOS 7.x

- SSL socket handling in Protocol module (send/recv)



## [0.1.0] - 2025-01-15



### Added

- Initial release (MVP)

- Binary protocol implementation for MikroTik RouterOS API

- Support for plain TCP connections (port 8728)

- Support for TLS connections (port 8729)

- MD5 challenge-response authentication

- Response parsing to Elixir maps

- Error handling with custom error struct

- Command execution with query filters

- Boolean type coercion

- Comprehensive documentation



[0.3.0]: https://github.com/jlbyh2o/routeros_api/compare/v0.2.0...v0.3.0

[0.2.0]: https://github.com/jlbyh2o/routeros_api/compare/v0.1.0...v0.2.0

[0.1.0]: https://github.com/jlbyh2o/routeros_api/releases/tag/v0.1.0