diff --git a/EgwConf.Iob/docfx.json b/EgwConf.Iob/docfx.json new file mode 100644 index 0000000..435e349 --- /dev/null +++ b/EgwConf.Iob/docfx.json @@ -0,0 +1,69 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "*.csproj", + "*.vbproj" + ], + "cwd": ".", + "exclude": [ + "**/obj/**", + "**/bin/**", + "_site/**" + ] + } + ], + "dest": "obj/api" + } + ], + "build": { + "content": [ + { + "files": [ + "api/**.yml" + ], + "cwd": "obj" + }, + { + "files": [ + "api/*.md", + "articles/**.md", + "toc.yml", + "*.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "resource": [ + { + "files": [ + "images/**" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "overwrite": [ + { + "files": [ + "apidoc/**.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "dest": "_site", + "template": [ + "default" + ] + } +} \ No newline at end of file diff --git a/EgwConf.Iob/index.md b/EgwConf.Iob/index.md new file mode 100644 index 0000000..3844385 --- /dev/null +++ b/EgwConf.Iob/index.md @@ -0,0 +1,40 @@ +# EgwProxy.Shelly Library + +Documentazione relativa alla libreria di interfaccia con sistemi Shelly x controllo domotico e del consumo energetico. + +Disponibile in forma di pacchetto nuget sul repo aziendale nexus.steamware.net: i pacchetti sono disponibili all'indirizzo + +https://nexus.steamware.net/#browse/browse:nuget-hosted + +Vedere la sezione Articles per maggiori informazioni sulle definizioni, l'impiego ed esempi. + +L'oggetto id base è **EgwProxy.Shelly.Clients.* ** + +Si sono provati apcchetti nuget ma non essendo soddisfacenti si è sviluppato custom da zero (partendod a esempi di chiamate nuget...) + +Riferimenti documentazione per Shelly: +- https://shelly-api-docs.shelly.cloud/gen2/#status +- https://shelly-api-docs.shelly.cloud/gen2/Devices/Gen3/Shelly1PMG3/ +- https://shelly-api-docs.shelly.cloud/gen2/General/ComponentConcept/ +- https://www.codeproject.com/Articles/5373077/Smart-Home-Controlling-Shelly-Devices-Part-1 +- https://www.codeproject.com/Articles/5374102/Smart-Home-Controlling-Shelly-Devices-Part-3 +- https://www.codeproject.com/Articles/5375803/Smart-Home-Controlling-Shelly-Devices-Part-4-Prope +- https://github.com/nrjohnstone/shelly.net/blob/master/src/Shelly.Net/Clients/ShellyClientBase.cs + +Link dispositivi interni +- http://10.74.81.71/ +- http://10.74.81.72/ + +Valutazioni standard x Flur vs RestSharp: +- https://flurl.dev/ +- https://jeremylindsayni.wordpress.com/2018/12/27/comparing-restsharp-and-flurl-http-while-consuming-a-web-service-in-net-core/ +- https://stackoverflow.com/questions/26996489/when-consuming-restful-apis-when-do-you-recommend-using-restsharp-and-when-http +- https://medium.com/@sudipdevdev/choosing-the-best-api-request-library-for-c-a-comparison-of-refit-flurl-and-restsharp-ff339c407c38 + +## Articles + +Per maggiori dettagli, definizioni e demo funzionamento si rimanda alla sezione Articles + +## Api + +Per ogni dettaglio e riferimento alla libreria si rimanda alla sezione Api Documentation \ No newline at end of file diff --git a/EgwConf.Iob/toc.yml b/EgwConf.Iob/toc.yml new file mode 100644 index 0000000..7eee9ff --- /dev/null +++ b/EgwConf.Iob/toc.yml @@ -0,0 +1,6 @@ + +- name: Articles + href: articles/ +- name: API Documentation + href: obj/api/ + homepage: api/index.md