senstate/csharp-client

Senstate C#-Client 👋

Install C# Client

Libary	Install
Shared Logic	Install-Package Senstate.CSharp-Client -Version 0.1.0
.Net Standard 2 Json/WebSocket Implementations	Install-Package Senstate.NetStandard -Version 0.1.0

Supported Platforms:

• NetStandard
• Blazor Server/WASM (Demo soon)

or Visit: Releases to download the Client & NetStandard Dlls.

Reference them as usual

Connect to Senstate

   var webSocket = new NetStandardWebSocketImplementation();
   webSocket.ExceptionThrown += (sender, e) =>  // Optional if you want to catch Connection issues
   {
      throw e.Exception;
   };

   SenstateContext.SerializerInstance = new NetStandardJsonNetImplementation();
   SenstateContext.WebSocketInstance = webSocket;
   SenstateContext.RegisterApp("Your Name");

Sending Data

You can send strings / numbers / (json) objects (see WatcherType Enum)

Create your Watcher:

   var stringWatcher = new Watcher(
      new WatcherMeta
      {
         Tag = "Some Label",
         Type = WatcherType.String, // or Number / Json
         Group = "Example Group 1"  // optional: if you want to group watchers
      }
   );

Send your data:

  stringWatcher.SendData($"This an example Text {i}");

Once there is a connection, the Data will be shown in the Dashboard.

Addtional Example to send objects:

Create your Watcher:

   var objectWatcher = new Watcher(
      new WatcherMeta
      {
         Tag = "Object",  // Just a label for this watcher
         Type = WatcherType.Json,
         Group = "Special"// optional:
      }
   );

Send your data:

   var someObject = new
   {
      example = true,
      sub = new
      {
         data = i
      }
   };

   // Any objects, but they can't have cyclic references
   // So that JsonNet can serialize those
   objectWatcher.SendData(someObject);

Sending Logs

Possible Log-Levels:

• Debug
• Info
• Warn
• Error

   Logger.SendLog(LoggerType.Debug, $"Debug {i}", someObject);  // optional: someObject
   Logger.SendLog(LoggerType.Info, $"Info {i}");

Sending Errors

   ErrorSender.Send(ex);

Show your support

Give a ⭐️ if this project helped you!

If you have features / ideas, open an issue :)

csharp-client's Issues

Add NuGet Package Badges

Godot C# Example

Spamming too often - WebSockets can only have sending at the time

ReceiveAsync and SendAsync can be called simultaneously, but at most one outstanding operation for each of them is allowed at the same time.

Add Performance Counter / Watchers

maybe even with using (IDisposable) ?

Publish Package to GitHub

publish files to release

https://github.com/actions/upload-release-asset

Add CI / Actions

• maybe also publish by action
• autosemver / push to repo?

Add Unity Example

Copy DLLs to the folder

Needed Libraries

• https://github.com/jilleJr/Newtonsoft.Json-for-Unity

Then use the example as before

Not needed anymore:
https://github.com/endel/NativeWebSocket