Everyone have written their share of trivial conversions - or less obvious ones where you need to Google that magic constant.
Stop littering your code with unnecessary calculations, Units.NET gives you all the common units of measurement and the conversions between them. It is light-weight and thoroughly tested.
- .NET Standard 1.0
- .NET 4.0
- .NET 3.5 Client
- Windows Runtime Component for UWP apps (JavaScript, C++ or C#)
- 50+ quantities with a total of 600+ units generated from JSON by Powershell scripts
- 1000+ unit tests on conversions and localizations
- Immutable structs that implement
Equatable,IComparable - Static typing to avoid ambiguous values or units
- Operator overloads for arithmetic on quantities
- Extension methods for short-hand creation and conversions
- Parse and ToString() supports cultures and localization
- Example: Creating a unit converter app
- Example: WPF app using IValueConverter to parse quantities from input
- Precision and accuracy
- Serializable with JSON.NET
- Extensible with custom units
- Contribute if you are missing some units
- Continuous integration posts status reports to pull requests and commits
- Who are using this?
Run the following command in the Package Manager Console or go to the NuGet site for the complete relase history.
// Convert to the unit of choice - when you need it
Mass weight = GetPersonWeight();
Console.WriteLine("You weigh {0:0.#} kg.", weight.Kilograms);
// Avoid confusing conversions, such as between weight (force) and mass
double weightNewtons = weight.Newtons; // No such thing
// Some popular conversions
Length meter = Length.FromMeters(1);
double cm = meter.Centimeters; // 100
double yards = meter.Yards; // 1.09361
double feet = meter.Feet; // 3.28084
double inches = meter.Inches; // 39.3701// Arithmetic
Length l1 = 2 * Length.FromMeters(1);
Length l2 = Length.FromMeters(1) / 2;
Length l3 = l1 + l2;
// Construct between units
Length distance = Speed.FromKilometersPerHour(80) * TimeSpan.FromMinutes(30);
Acceleration a1 = Speed.FromKilometersPerHour(80) / TimeSpan.FromSeconds(2);
Acceleration a2 = Force.FromNewtons(100) / Mass.FromKilograms(20);
RotationalSpeed r = Angle.FromDegrees(90) / TimeSpan.FromSeconds(2);All units have associated extension methods for a really compact, expressive way to construct values or do arithmetic.
using UnitsNet.Extensions.NumberToDuration;
using UnitsNet.Extensions.NumberToLength;
using UnitsNet.Extensions.NumberToTimeSpan;
Speed speed = 30.Kilometers() / 1.Hours(); // 30 km/h (using Duration type)
Length distance = speed * 2.h(); // 60 km (using TimeSpan type)
Acceleration stdGravity = 9.80665.MetersPerSecondSquared();
Force weight = 80.Kilograms() * stdGravity; // 80 kilograms-force or 784.532 newtonsThe culture for abbreviations defaults to Thread.CurrentUICulture and falls back to US English if not defined. Thread.CurrentCulture affects number formatting unless a custom culture is specified. The relevant methods are:
- ToString()
- GetAbbreviation()
- Parse/TryParse()
- ParseUnit/TryParseUnit()
var usEnglish = new CultureInfo("en-US");
var russian = new CultureInfo("ru-RU");
var oneKg = Mass.FromKilograms(1);
// Honors Thread.CurrentUICulture
Thread.CurrentUICulture = russian;
string kgRu = oneKg.ToString(); // "1 кг"
// ToString() with specific culture and string format pattern
string mgUs = oneKg.ToString(MassUnit.Milligram, usEnglish, "{1} {0:0.00}"); // "mg 1.00"
string mgRu = oneKg.ToString(MassUnit.Milligram, russian, "{1} {0:0.00}"); // "мг 1,00"
// Parse measurement from string
Mass kg = Mass.Parse(usEnglish, "1.0 kg");
// Parse unit from string, a unit can have multiple abbreviations
RotationalSpeedUnit rpm1 == RotationalSpeed.ParseUnit("rpm"); // RotationalSpeedUnit.RevolutionPerMinute
RotationalSpeedUnit rpm2 == RotationalSpeed.ParseUnit("r/min"); // RotationalSpeedUnit.RevolutionPerMinute
// Get default abbreviation for a unit
string abbrevKg = Mass.GetAbbreviation(MassUnit.Kilogram); // "kg"Source code for Samples/UnitConverter.Wpf
Download (release 2018-02-04 for Windows)
This example shows how you can create a dynamic unit converter, where the user selects the quantity to convert, such as Length or Mass, then selects to convert from Meter to Centimeter and types in a value for how many meters.
NOTE: There are still some limitations in the library that requires reflection to enumerate units for quantity and getting the abbreviation for a unit, when we want to dynamically enumerate and convert between units.
If you can live with hard coding what quantities to convert between, then the following code snippet shows you one way to go about it:
// Get quantities for populating quantity UI selector
QuantityType[] quantityTypes = Enum.GetValues(typeof(QuantityType)).Cast<QuantityType>().ToArray();
// If Length is selected, get length units for populating from/to UI selectors
LengthUnit[] lengthUnits = Length.Units;
// Perform conversion using input value and selected from/to units
double inputValue; // Obtain from textbox
LengthUnit fromUnit, toUnit; // Obtain from ListBox selections
double resultValue = Length.From(inputValue, fromUnit).As(toUnit);
// Alternatively, you can also convert using string representations of units
double centimeters = UnitConverter.ConvertByName(5, "Length", "Meter", "Centimeter"); // 500
double centimeters2 = UnitConverter.ConvertByAbbreviation(5, "Length", "m", "cm"); // 500
The purpose of this app is to show how to create an IValueConverter in order to bind XAML to quantities.
NOTE: A lot of reflection and complexity was introduced due to not having a base type. See #371 for discussion on adding base types.
A base unit is chosen for each unit class, represented by a double value (64-bit), and all conversions go via this unit. This means there will always be a small error in both representing other units than the base unit as well as converting between units.
Units.NET was intended for convenience and ease of use, not highly accurate conversions, but I am open to suggestions for improvements.
The tests accept an error up to 1E-5 for most units added so far. Exceptions include units like Teaspoon, where the base unit cubic meter is a lot bigger. In many usecases this is sufficient, but for others this may be a showstopper and something you need to be aware of.
For more details, see Precision.
Important! We cannot guarantee backwards compatibility, although we will strive to do that on a "best effort" basis and bumping the major nuget version when a change is necessary.
The base unit of any unit should be be treated as volatile as we have changed this several times in the history of this library already. Either to reduce precision errors of common units or to simplify code generation. An example is Mass, where the base unit was first Kilogram as this is the SI unit of mass, but in order to use powershell scripts to generate milligrams, nanograms etc. it was easier to choose Gram as the base unit of Mass.
This project is still early and many units and conversions are not yet covered. If you are missing something, please help by contributing or ask for it by creating an issue.
Please read the wiki on Adding a New Unit.
Generally adding a unit involves adding or modifying UnitsNet\UnitDefinitions\*.json files and running generate-code.bat to regenerate the source code and test code stubs, then manually implementing the new unit conversion constants in the test code.
- Fork the repo
- Do work on branches such as feature/add-myunit and fix/34
- Create a pull request
AppVeyor performs the following:
- Build and test all branches
- Build and test pull requests, notifies on success or error
- Deploy nugets on master branch, if nuspec versions changed
It would be awesome to know who are using this library. If you would like your project listed here, create an issue or edit the README.md and send a pull request. Max logo size is 300x35 pixels and should be in .png, .gif or .jpg formats.
Sports performance applications for Windows and iOS, that combine high-speed video with sensor data to bring facts into your training and visualize the invisible forces at work
Units.NET started here in 2007 when reading strain gauge measurements from force plates and has been very useful in integrating a number of different sensor types into our software and presenting the data in the user's preferred culture and units.
https://www.swingcatalyst.com (for golf)
https://www.motioncatalyst.com (everything else)
- Andreas Gullberg Larsen, CTO (andreas@motioncatalyst.com)
Award-winning performers and composers put everything they’ve got into their music. PK Sound makes sure their fans will hear it all – brilliantly, precisely, consistently.
PK Sound uses UnitsNet in Kontrol - the remote control counterpart to Trinity, the world's only robotic line array solution.
http://www.pksound.ca/pk-sound/announcing-the-official-release-of-kontrol/ (for an idea of what the Kontrol project is)
http://www.pksound.ca/trinity/ (the speakers that Kontrol currently controls)
http://www.pksound.ca/ (everything else)
- Jules LaPrairie, Kontrol software team member
Microsoft.IoT.Devices extends Windows IoT Core and makes it easier to support devices like sensors and displays. It provides event-driven access for many digital and analog devices and even provides specialized wrappers for devices like joystick, rotary encoder and graphics display.
http://aka.ms/iotdevices (home page including docs)
http://www.nuget.org/packages/Microsoft.IoT.Devices (NuGet package)
Software for creating printable hex maps for use in pen and paper RPGs. Both a user-friendly app and a high-level library for generating labelled hexmaps.
https://bitbucket.org/MartinEden/Crawlspace
- Martin Eden, project maintainer