HomeFrontCommand 4.0.0

HomeFrontCommandLibrary

?? A C# library for retrieving alerts from Israel's Home Front Command (????? ?????) Provides access to real-time rocket/siren alerts and alert history, with multi-language support for city and category names.

?? Installation

Via NuGet:

dotnet add package HomeFrontCommand

Or clone this repository and reference the project directly.

? Features

• Get the current active alert
• Fetch historical alert data
• All responses include all languages (Hebrew, Russian, English, Arabic) � no need to specify language
• Get all cached cities with GetAllCities()
• In-memory caching support for optimal performance

?? Quick Start

using HomeFrontCommandLibrary;

class Program
{
    static async Task Main()
    {
        var command = new HomeFrontCommand();

        // Get current active alert
        var activeAlert = await command.GetActiveAlert();
        if (activeAlert.Category != null)
        {
            // Access category in any language
            Console.WriteLine($"Alert (Hebrew): {activeAlert.Category.Title.Hebrew}");
            Console.WriteLine($"Alert (Russian): {activeAlert.Category.Title.Russian}");
            Console.WriteLine($"Alert (English): {activeAlert.Category.Title.English}");

            // Access cities in any language
            foreach (var city in activeAlert.Cities!)
            {
                Console.WriteLine($" - {city.Name.Hebrew} / {city.Name.English}");
            }
        }

        // Get alert history
        var history = await command.GetAlertsHistory();
        foreach (var alert in history.Take(5))
        {
            Console.WriteLine($"{alert.AlertDate}: {alert.City.Name.Hebrew} - {alert.Category.Title.Russian}");
        }

        // Get all cached cities
        var allCities = command.GetAllCities();
        Console.WriteLine($"Total cities: {allCities.Count}");
    }
}

?? Models

Alert

public class Alert
{
    public required string? Id { get; set; }
    public Category? Category { get; set; }
    public List<City>? Cities { get; set; }
    public DateTime AlertDate { get; set; }
}

AlertHistory

public class AlertHistory
{
    public required Category Category { get; set; }
    public required City City { get; set; }
    public DateTime AlertDate { get; set; }
}

Category

public class Category
{
    public int Id { get; set; }
    public int MatrixId { get; set; }
    public required CategoryTitle Title { get; set; }
    public required CategoryDescription Description { get; set; }
}

public class CategoryTitle
{
    public string Hebrew { get; set; } = string.Empty;
    public string English { get; set; } = string.Empty;
    public string Russian { get; set; } = string.Empty;
    public string Arabic { get; set; } = string.Empty;
}

public class CategoryDescription
{
    public string Hebrew { get; set; } = string.Empty;
    public string English { get; set; } = string.Empty;
    public string Russian { get; set; } = string.Empty;
    public string Arabic { get; set; } = string.Empty;
}

City

public class City
{
    public int Id { get; set; }
    public int AreaId { get; set; }
    public required CityName Name { get; set; }
    public required ReshutName Reshut { get; set; }
    public string AreaName { get; set; } = string.Empty;
    public int ProtectionTime { get; set; }
}

public class CityName
{
    public string Hebrew { get; set; } = string.Empty;
    public string English { get; set; } = string.Empty;
    public string Russian { get; set; } = string.Empty;
    public string Arabic { get; set; } = string.Empty;
}

public class ReshutName
{
    public string Hebrew { get; set; } = string.Empty;
    public string English { get; set; } = string.Empty;
    public string Russian { get; set; } = string.Empty;
    public string Arabic { get; set; } = string.Empty;
}

?? Multi-Language Support

All responses automatically include translations in all supported languages:

Example:

var city = await command.GetCityByName("?? ????");
Console.WriteLine(city.Name.Hebrew);   // ?? ????
Console.WriteLine(city.Name.English);  // Tel Aviv
Console.WriteLine(city.Name.Russian);  // ????-????
Console.WriteLine(city.Name.Arabic);   // ?? ????

?? Dependencies

• Newtonsoft.Json � for JSON serialization
• Microsoft.Extensions.Caching.Memory � in-memory caching

?? Roadmap

• Dependency Injection support
• Unit test coverage
• Redis or external cache support
• Additional data endpoints

?? License

MIT � Rafael Chasman