Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
smdn authored Jan 30, 2025
1 parent b72fdf9 commit 5bd5a91
Showing 1 changed file with 17 additions and 18 deletions.
35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@
- [tests/](./tests/) - 各ライブラリ(アセンブリ)のNUnitテストスイートです。 各ディレクトリは、`テスト対象のアセンブリ名`/`名前空間`の階層構造になっています。

## Smdn.Net.EchonetLite
[![NuGet](https://img.shields.io/nuget/v/Smdn.Net.EchonetLite.svg)](https://www.nuget.org/packages/Smdn.Net.EchonetLite/)

[Smdn.Net.EchonetLite](./src/Smdn.Net.EchonetLite/)は、「[ECHONET Lite SPECIFICATION 第2部 ECHONET Lite 通信ミドルウェア仕様](https://echonet.jp/spec_g/)」(en:[Part II ECHONET Lite Communication Middleware Specifications](https://echonet.jp/spec_g/))に記載されている仕様に基づく実装を提供します。

[![NuGet](https://img.shields.io/nuget/v/Smdn.Net.EchonetLite.svg)](https://www.nuget.org/packages/Smdn.Net.EchonetLite/)

<details>
<summary>Read More</summary>

Expand All @@ -35,31 +35,31 @@ version 2.0.0時点では、[同仕様Ver.1.14](https://echonet.jp/spec_v114_lit


## Smdn.Net.EchonetLite.RouteB
[![NuGet](https://img.shields.io/nuget/v/Smdn.Net.EchonetLite.RouteB.svg)](https://www.nuget.org/packages/Smdn.Net.EchonetLite.RouteB/)

[Smdn.Net.EchonetLite.RouteB](./src/Smdn.Net.EchonetLite.RouteB/)は、「[低圧スマート電力量メータ・HEMS コントローラ間アプリケーション通信インタフェース仕様書](https://echonet.jp/spec_g/)」(en:[Interface Specification for Application Layer Communication between Smart Electric Energy Meters and HEMS Controllers](https://echonet.jp/spec-en/))に記載されている仕様に基づく実装を提供します。

[![NuGet](https://img.shields.io/nuget/v/Smdn.Net.EchonetLite.RouteB.svg)](https://www.nuget.org/packages/Smdn.Net.EchonetLite.RouteB/)

<details>
<summary>Read More</summary>

このライブラリでは、低圧スマート電力量メータとの通信を確立するための対向デバイスとなる**HEMSコントローラ**を実装する`HemsController`、また**機器オブジェクト詳細規定**で規定される低圧スマート電力量メータクラスを実装し、実際に値を読み出すためAPIを提供する`LowVoltageSmartElectricEnergyMeter`、Bルートでの通信機能と認証情報を`IServiceCollection`に追加するためのDI機構を提供する拡張メソッドなどを提供します。

実際にスマートメーターとの通信を行うには、Bルートサービスに接続可能なデバイス、及びそれを操作する`RouteBEchonetLiteHandler`の具象クラスが必要です。 具体的には、`Smdn.Net.EchonetLite.RouteB.BP35XX`などのライブラリと組み合わせて使用してください。

</details>

> [!NOTE]
> version 2.0.0時点の`LowVoltageSmartElectricEnergyMeter`は、APPENDIX Release KまでのECHONETプロパティが実装済み・実機動作確認済みとなっています。
> これ以降のReleaseで追加されたECHONETプロパティについては、実機での動作が確認出来次第、実装したいと考えています。
> より新しいECHONETプロパティを搭載するスマートメータでの動作検証が可能な方がいましたら、ご協力ください。
</details>
>
> これ以降のReleaseで追加されたECHONETプロパティについては、実機での動作が確認出来次第、実装したいと考えています。 より新しいECHONETプロパティを搭載するスマートメータでの動作検証が可能な方がいましたら、ご協力ください。


## Smdn.Net.SmartMeter
[![NuGet](https://img.shields.io/nuget/v/Smdn.Net.SmartMeter.svg)](https://www.nuget.org/packages/Smdn.Net.SmartMeter/)

[Smdn.Net.SmartMeter](./src/Smdn.Net.SmartMeter/)は、スマートメーターから定期的なデータ収集を行うためのAPIを提供します。

[![NuGet](https://img.shields.io/nuget/v/Smdn.Net.SmartMeter.svg)](https://www.nuget.org/packages/Smdn.Net.SmartMeter/)

<details>
<summary>Read More</summary>

Expand All @@ -73,10 +73,10 @@ version 2.0.0時点では、[同仕様Ver.1.14](https://echonet.jp/spec_v114_lit
## その他のライブラリ

### Smdn.Net.EchonetLite.Primitives
[![NuGet](https://img.shields.io/nuget/v/Smdn.Net.EchonetLite.Primitives.svg)](https://www.nuget.org/packages/Smdn.Net.EchonetLite.Primitives/)

`Smdn.Net.EchonetLite.*`で共通して使用される型と抽象化機能を提供します。

[![NuGet](https://img.shields.io/nuget/v/Smdn.Net.EchonetLite.Primitives.svg)](https://www.nuget.org/packages/Smdn.Net.EchonetLite.Primitives/)

<details>
<summary>Read More</summary>

Expand All @@ -85,10 +85,10 @@ version 2.0.0時点では、[同仕様Ver.1.14](https://echonet.jp/spec_v114_lit


### Smdn.Net.EchonetLite.RouteB.Primitives
[![NuGet](https://img.shields.io/nuget/v/Smdn.Net.EchonetLite.RouteB.Primitives.svg)](https://www.nuget.org/packages/Smdn.Net.EchonetLite.RouteB.Primitives/)

`Smdn.Net.EchonetLite.RouteB.*`で共通して使用される型と抽象化機能を提供します。

[![NuGet](https://img.shields.io/nuget/v/Smdn.Net.EchonetLite.RouteB.Primitives.svg)](https://www.nuget.org/packages/Smdn.Net.EchonetLite.RouteB.Primitives/)

<details>
<summary>Read More</summary>

Expand All @@ -97,22 +97,21 @@ Bルートサービスに接続してスマートメーターとの通信を行


### Smdn.Net.EchonetLite.Appendix
[![NuGet](https://img.shields.io/nuget/v/Smdn.Net.EchonetLite.Appendix.svg)](https://www.nuget.org/packages/Smdn.Net.EchonetLite.Appendix/)

[Smdn.Net.EchonetLite.Appendix](./src/Smdn.Net.EchonetLite.Appendix/)は、「[ECHONET SPECIFICATION APPENDIX ECHONET 機器オブジェクト詳細規定](https://echonet.jp/spec_g/)」(en:[APPENDIX Detailed Requirements for ECHONET Device objects](https://echonet.jp/spec_g/))に記載されているクラスグループ・機器オブジェクト・プロパティ構成の定義、およびその定義を参照するためのAPIを提供します。

[![NuGet](https://img.shields.io/nuget/v/Smdn.Net.EchonetLite.Appendix.svg)](https://www.nuget.org/packages/Smdn.Net.EchonetLite.Appendix/)

<details>
<summary>Read More</summary>

[APPENDIX ECHONET機器オブジェクト詳細規定 Release K (日本語版)](https://echonet.jp/spec_old_lite/#standard-03)をもとに[生成したJSONファイル](./src/Smdn.Net.EchonetLite.Appendix/MasterData/)をアセンブリのリソースとして埋め込んでいます。 また、それを読み取るクラス郡を実装しています。
</details>

> [!NOTE]
> 本ライブラリは、オリジナルにおける`EchoDotNetLite.Specifications`をベースにしています。 オリジナルでは手作業によりAPPENDIXからJSONへ変換しているため、その過程で脱字・転記ミス等が発生している可能性あります。
>
> 今後のバージョンで、より新しいReleaseへの追従、および[Machine Readable Appendix](https://echonet.jp/spec_g/)をベースにした生成手段を使用するよう改善予定です。
</details>



### その他のプロジェクト/ライブラリ
Expand Down

0 comments on commit 5bd5a91

Please sign in to comment.