Init
This commit is contained in:
67
GoveeCSharpConnector/Interfaces/IGoveeApiService.cs
Normal file
67
GoveeCSharpConnector/Interfaces/IGoveeApiService.cs
Normal file
@ -0,0 +1,67 @@
|
||||
using GoveeCSharpConnector.Objects;
|
||||
|
||||
namespace GoveeCSharpConnector.Interfaces;
|
||||
|
||||
public interface IGoveeApiService
|
||||
{
|
||||
/// <summary>
|
||||
/// Sets the required Api Key for the Govee Api.
|
||||
/// Request Api Key in the Mobile Phone App.
|
||||
/// </summary>
|
||||
/// <param name="apiKey">Api Key as String</param>
|
||||
void SetApiKey(string apiKey);
|
||||
/// <summary>
|
||||
/// Returns current set Govee Api Key
|
||||
/// </summary>
|
||||
/// <returns>Govee Api Key as String</returns>
|
||||
string GetApiKey();
|
||||
/// <summary>
|
||||
/// Removes the Set Api Key and resets the HTTP Header
|
||||
/// </summary>
|
||||
void RemoveApiKey();
|
||||
/// <summary>
|
||||
/// Requests all Devices registered to Api Key Govee Account
|
||||
/// </summary>
|
||||
/// <returns>List of GoveeApiDevices</returns>
|
||||
Task<List<GoveeApiDevice>> GetDevices();
|
||||
/// <summary>
|
||||
/// Requests the State of a single Govee Device
|
||||
/// </summary>
|
||||
/// <param name="deviceId">Device Id Guid as string</param>
|
||||
/// <param name="deviceModel">Device Model Number as string</param>
|
||||
/// <returns>GoveeApiStat Object</returns>
|
||||
public Task<GoveeApiState> GetDeviceState(string deviceId, string deviceModel);
|
||||
/// <summary>
|
||||
/// Sets the On/Off state of a single Govee Device
|
||||
/// </summary>
|
||||
/// <param name="deviceId">Device Id Guid as string</param>
|
||||
/// <param name="deviceModel">Device Model Number as string</param>
|
||||
/// <param name="on"></param>
|
||||
/// <returns></returns>
|
||||
public Task ToggleState(string deviceId, string deviceModel, bool on);
|
||||
/// <summary>
|
||||
/// Sets the Brightness in Percent of a single Govee Device
|
||||
/// </summary>
|
||||
/// <param name="deviceId">Device Id Guid as string</param>
|
||||
/// <param name="deviceModel">Device Model Number as string</param>
|
||||
/// <param name="value">Brightness in Percent as Int</param>
|
||||
/// <returns></returns>
|
||||
public Task SetBrightness(string deviceId, string deviceModel, int value);
|
||||
/// <summary>
|
||||
/// Sets a Rgb Color of a single Govee Device
|
||||
/// </summary>
|
||||
/// <param name="deviceId">Device Id Guid as string</param>
|
||||
/// <param name="deviceModel">Device Model Number as string</param>
|
||||
/// <param name="color">Rgb Color</param>
|
||||
/// <returns></returns>
|
||||
public Task SetColor(string deviceId, string deviceModel, RgbColor color);
|
||||
/// <summary>
|
||||
/// Sets the Color Temperature of a single Govee Device
|
||||
/// </summary>
|
||||
/// <param name="deviceId">Device Id Guid as string</param>
|
||||
/// <param name="deviceModel">Device Model Number as string</param>
|
||||
/// <param name="value">Color Temp in Kelvin as Int</param>
|
||||
/// <returns></returns>
|
||||
public Task SetColorTemp(string deviceId, string deviceModel, int value);
|
||||
|
||||
}
|
63
GoveeCSharpConnector/Interfaces/IGoveeUdpService.cs
Normal file
63
GoveeCSharpConnector/Interfaces/IGoveeUdpService.cs
Normal file
@ -0,0 +1,63 @@
|
||||
using System.Data;
|
||||
using GoveeCSharpConnector.Objects;
|
||||
|
||||
namespace GoveeCSharpConnector.Interfaces;
|
||||
|
||||
public interface IGoveeUdpService
|
||||
{
|
||||
/// <summary>
|
||||
/// Sends a Scan Command via Udp Multicast.
|
||||
/// </summary>
|
||||
/// <param name="timeout">Standard 200ms</param>
|
||||
/// <returns>List of GoveeUdpDevices</returns>
|
||||
Task<List<GoveeUdpDevice>> GetDevices(TimeSpan? timeout = null);
|
||||
|
||||
/// <summary>
|
||||
/// Request the State of the Device
|
||||
/// </summary>
|
||||
/// <param name="deviceAddress">Ip Address of the Device</param>
|
||||
/// <param name="uniCastPort">Port of the Device. Standard 4003</param>
|
||||
/// <param name="timeout">Standard 200ms</param>
|
||||
/// <returns></returns>
|
||||
Task<GoveeUdpState> GetState(string deviceAddress, int uniCastPort = 4003, TimeSpan? timeout = null);
|
||||
|
||||
/// <summary>
|
||||
/// Sets the On/Off State of the Device
|
||||
/// </summary>
|
||||
/// <param name="deviceAddress">Ip Address of the Device</param>
|
||||
/// <param name="on"></param>
|
||||
/// <param name="uniCastPort">Port of the Device. Standard 4003</param>
|
||||
/// <returns></returns>
|
||||
Task ToggleDevice(string deviceAddress, bool on, int uniCastPort = 4003);
|
||||
/// <summary>
|
||||
/// Sets the Brightness of the Device
|
||||
/// </summary>
|
||||
/// <param name="deviceAddress">Ip Address of the Device</param>
|
||||
/// <param name="brightness">In Percent 1-100</param>
|
||||
/// <param name="uniCastPort">Port of the Device. Standard 4003</param>
|
||||
/// <returns></returns>
|
||||
Task SetBrightness(string deviceAddress, short brightness, int uniCastPort = 4003);
|
||||
/// <summary>
|
||||
/// Sets the Color of the Device
|
||||
/// </summary>
|
||||
/// <param name="deviceAddress">Ip Address of the Device</param>
|
||||
/// <param name="color"></param>
|
||||
/// <param name="uniCastPort">Port of the Device. Standard 4003</param>
|
||||
/// <returns></returns>
|
||||
Task SetColor(string deviceAddress, RgbColor color, int uniCastPort = 4003);
|
||||
/// <summary>
|
||||
/// Starts the Udp Listener
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
void StartUdpListener();
|
||||
/// <summary>
|
||||
/// Returns the State of the Udp Listener
|
||||
/// </summary>
|
||||
/// <returns>True if Active</returns>
|
||||
bool IsListening();
|
||||
/// <summary>
|
||||
/// Stops the Udp Listener
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
void StopUdpListener();
|
||||
}
|
Reference in New Issue
Block a user