nanokvm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c4dbfc58ba42afd4eb0023e7cbbba8fca9d14a970587f0c417ca7f1d5b823363
+  data.tar.gz: 1ce5ae6d4fde33cf03996018754e5fa4a80eb94cc3fdb73fa159cdaa4e498922
+SHA512:
+  metadata.gz: eecc93304d4412c74d79768ed5cb6032e5a06e26e3b9cd76e89d97d114b2c0772d926ed9a0f0809cd1666b4c01d7ad033462608d9ff753766a385dc27c831ade
+  data.tar.gz: fe335aa81f118362864e7c30fe8825e3784978bf638835f2e069ee0806694f26da873dbe30bd01b034c9255daeba3bd437940308c82e9bdde47b009b9467fdec

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# 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).
+
+## [0.1.0] - 2025-04-21
+
+### Added
+- Initial release
+- Basic NanoKVM API client
+- CLI interface for common operations
+- Support for authentication, power control, virtual devices, and more
+- Download status now shows time estimates and download speed
+- Added --timeout option to download-status command for limiting monitoring time
+- Download status now includes bytes downloaded and total file size
+- Automatic HTTP file size detection for download URLs
+- Improved progress display with visual progress bar
+- Smooth in-place refresh of download status without screen flickering
+
+### Fixed
+- Fixed error when calculating download speed without size information
+- Fixed timeout display in download monitoring 

data/README.md

@@ -0,0 +1,314 @@
+# NanoKVM Ruby Gem
+
+A Ruby library and CLI for controlling NanoKVM devices.
+
+## Installation
+
+Install the gem:
+
+```bash
+gem install nanokvm
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem 'nanokvm'
+```
+
+## CLI Usage
+
+The nanokvm command provides a convenient way to interact with your NanoKVM device.
+
+### Configuration
+
+First, configure your default device settings:
+
+```bash
+nanokvm configure --host 192.168.1.18 --username admin --password admin
+```
+
+### Getting Device Info
+
+```bash
+nanokvm info
+```
+
+### Power Control
+
+Press the power button (short press):
+
+```bash
+nanokvm power
+```
+
+Long press (force shutdown):
+
+```bash
+nanokvm power --duration 8000
+```
+
+Press the reset button:
+
+```bash
+nanokvm reset
+```
+
+### LED Status
+
+```bash
+nanokvm leds
+```
+
+### Password Status
+
+Check if the device is using the default password:
+
+```bash
+nanokvm is-password-updated
+```
+
+### Virtual Disks
+
+List available images:
+
+```bash
+nanokvm images
+```
+
+Mount an image:
+
+```bash
+nanokvm mount /data/ubuntu-24.04-desktop-amd64.iso
+```
+
+### Virtual Devices
+
+Show virtual device status:
+
+```bash
+nanokvm virtual
+```
+
+Toggle virtual network or disk:
+
+```bash
+nanokvm toggle network
+nanokvm toggle disk
+```
+
+### Type Text
+
+Send keyboard input to the target:
+
+```bash
+nanokvm type "ls -la"
+```
+
+### Tailscale
+
+Check Tailscale extension status:
+
+```bash
+nanokvm tailscale
+```
+
+### Image Download
+
+Check if downloading images is enabled:
+
+```bash
+nanokvm download-enabled
+```
+
+Check status of image download:
+
+```bash
+nanokvm download-status
+```
+
+Monitor download progress until completion (includes download speed and time estimate):
+
+```bash
+nanokvm download-status --monitor
+nanokvm download-status --monitor --interval=5  # Update every 5 seconds
+nanokvm download-status --monitor --timeout=60  # Stop monitoring after 60 seconds
+```
+
+Download an image from URL:
+
+```bash
+nanokvm download-image https://releases.ubuntu.com/24.04.2/ubuntu-24.04.2-live-server-amd64.iso
+```
+
+### Hardware Information
+
+Get information about the NanoKVM hardware:
+
+```bash
+nanokvm hardware
+```
+
+### Memory Management
+
+Get or set memory limits:
+
+```bash
+nanokvm memory-limit
+nanokvm memory-limit --enabled=true --limit=512
+```
+
+### OLED Settings
+
+Get or set OLED sleep timeout:
+
+```bash
+nanokvm oled
+nanokvm oled --sleep=60
+```
+
+### SSH, mDNS and Wake-on-LAN
+
+Get SSH server status:
+
+```bash
+nanokvm ssh-status
+```
+
+Get mDNS status:
+
+```bash
+nanokvm mdns
+```
+
+Get Wake-on-LAN MAC address:
+
+```bash
+nanokvm wol-mac
+```
+
+### CD-ROM and Script
+
+Get CD-ROM information:
+
+```bash
+nanokvm cdrom
+```
+
+Get script information:
+
+```bash
+nanokvm script
+```
+
+### HID Mode and Preview
+
+Get or set HID mode:
+
+```bash
+nanokvm hid-mode
+nanokvm hid-mode --mode=usb
+```
+
+Get or set preview state:
+
+```bash
+nanokvm preview
+nanokvm preview --enable=true
+```
+
+## Ruby Library Usage
+
+### Basic Usage
+
+```ruby
+require 'nanokvm'
+
+# Create a client
+client = NanoKVM::Client.new(
+  host: "192.168.1.18",
+  username: "admin",
+  password: "admin"
+)
+
+# Authenticate
+client.login
+
+# Get device info
+info = client.get_device_info
+puts info.inspect
+
+# Press power button
+client.power_button
+
+# Mount ISO
+client.mount_image("/data/ubuntu-24.04-desktop-amd64.iso")
+
+# Send text
+client.send_text("Hello from Ruby")
+```
+
+### Configuration
+
+You can set default configuration options:
+
+```ruby
+NanoKVM.configure do |config|
+  config.default_host = "192.168.1.18"
+  config.default_username = "admin"
+  config.default_password = "admin"
+end
+
+# Now you can create clients without specifying parameters
+client = NanoKVM::Client.new
+client.login
+```
+
+## Available Methods
+
+The client provides these main methods:
+
+- `login`
+- `get_device_info`
+- `get_gpio_state`
+- `power_button(duration = 800)`
+- `reset_button(duration = 200)`
+- `get_available_images`
+- `get_mounted_image`
+- `mount_image(file_path)`
+- `get_virtual_device_status`
+- `toggle_virtual_device(device)` (device can be "network" or "disk")
+- `send_text(content)`
+- `reset_hid`
+- `is_password_updated`
+- `get_account_info`
+- `get_network_info`
+- `get_app_version`
+- `system_reboot`
+- `reset_hdmi`
+- `get_tailscale_status`
+- `is_download_image_enabled`
+- `get_download_image_status`
+- `download_image(url)`
+- `get_hardware_info`
+- `get_script_info`
+- `get_memory_limit`
+- `set_memory_limit(enabled, limit_mb)`
+- `get_oled_info`
+- `set_oled_sleep(sleep_seconds)`
+- `get_ssh_status`
+- `get_mdns_status`
+- `get_cdrom_info`
+- `get_wol_mac`
+- `get_hid_mode`
+- `set_hid_mode(mode)`
+- `get_preview_state`
+- `set_preview_state(enable)`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). 

data/bin/nanokvm

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+
+require "nanokvm"
+require "nanokvm/cli"
+
+NanoKVM::CLI.start(ARGV)