Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgedevs committed Jun 28, 2024
1 parent b9ad9e2 commit 6d9ac69
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 27 deletions.
Binary file removed Image_Assets/Clima.jpg
Binary file not shown.
Binary file removed Image_Assets/Clima_Fritzing_Diagram.png
Binary file not shown.
Binary file removed Image_Assets/Clima_android.png
Binary file not shown.
Binary file modified Image_Assets/clima-banner.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 18 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
Clima is a solar-powered, custom embedded-IoT solution that tracks climate from a suite of sensors, saves data locally for access via Bluetooth, uses a RESTful Web API, and synchronizes data to the cloud.

## Contents
* [Clima Pro](#clima)
* [Assembly Instructions](#assembly-instructions)
* [Getting Started](#getting-started)
* [Hardware Specifications](#hardware-specifications)
* [Mobile Companion App](#mobile-companion-app)
* [Get an API Key for OpenWeather](#get-an-api-key-for-openweather)
* [Clima.HackKit](#climahackkit)
* [Support](#support)

## Clima

With this kit, it includes the complete package of sensors, PCB enclosure and mount to place this outdoors. You'll be able to measure wind speed/direction, rain volume, atmospheric conditions like temperature, pressure, humidity, CO2 levels and GPS Coordinates.

<img src="Image_Assets/ClimaPro.jpg" />
Expand All @@ -31,37 +31,28 @@ To simplify the way to use this Meadow-powered reference IoT product, we've crea
- `dotnet add package Meadow.Clima`, or
- [Meadow.Clima Nuget Package](https://www.nuget.org/packages/Meadow.Clima/)

2. Instantiate the `IClimaHardware` object:
2. Change the App type on your MeadowApp class to `ClimaAppBase` and initialize Clima's `MainController` passing the `Hardware` and a `INetworkAdapter` such as your WiFi adapter onboard the Meadow Core Compute Module:

```csharp
public class MeadowApp : App<F7CoreComputeV2>
public class ClimaApp : ClimaAppBase
{
IClimaHardware clima;

public override Task Initialize()
{
clima = Clima.Create();
...
```
Resolver.Log.Info($"Initialize...");

3. To Access the `Clima` onboard peripherals (AtmosphericSensor, for example):
```csharp
if (clima.AtmosphericSensor is { } bme688)
{
bme688.Updated += Bme688Updated;
bme688.StartUpdating();
}
```
var mainController = new MainController();

4. Like on step 3, you can also access the rest of peripherals:
- `EnvironmentalSensor` - Access the SCD40 sensor
- `WindVane` - Access the Wind Vane to check wind direction
- `RainGauge` - Access the Rain Gauge to check rain volume
- `Anemometer` - Access the Anemometer to get wind speed
- `SolarVoltageInput` - Access the voltage input from the Solar Add-on
- `Gnss` - Access the NEO-M8 GNSS/GPS module
- `ColorLed` - Access an RGB LED
var wifi = Hardware.ComputeModule.NetworkAdapters.Primary<IWiFiNetworkAdapter>();

mainController.Initialize(
hardware: Hardware,
networkAdapter: wifi);
.
.
.
```

5. Run the [Clima_Demo](Source/Clima_Demo/) project that uses all the peripherals onboard and outputs readings every few seconds.
3. Run the [Clima_Demo](Source/Clima_Demo/) project that does periodic readings of all its sensors and sends them to [Meadow.Cloud](https://www.meadowcloud.co) if you have a Wilderness Labs account and have provisioned your device.
## Hardware Specifications

Expand Down

0 comments on commit 6d9ac69

Please sign in to comment.