Skip to content

Commit

Permalink
Merge pull request #750 from WildernessLabs/develop
Browse files Browse the repository at this point in the history
Doc fixes
  • Loading branch information
jorgedevs authored May 30, 2024
2 parents 005c3b2 + 61dbbbe commit 5877cbd
Show file tree
Hide file tree
Showing 13 changed files with 236 additions and 182 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode in a new Terminal within enter the following command to create a new Meadow.Desktop project:

```console
dotnet new MeadowDesktop --name LinuxDemo
dotnet new meadow-desktop --name LinuxDemo
```

This Meadow.Desktop application creates a 320x240 pixel window saying `Hello, World` using [MicroLayout](../../../Meadow.Foundation/Libraries_and_Frameworks/MicroLayout/index.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode in a new Terminal within enter the following command to create a new Meadow.Desktop project:

```console
dotnet new MeadowDesktop --name MacDemo
dotnet new meadow-desktop --name MacDemo
```

This Meadow.Desktop application opens a 320x240 pixel window saying `Hello, World` using [MicroLayout](../../../Meadow.Foundation/Libraries_and_Frameworks/MicroLayout/index.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode in a new Terminal within enter the following command to create a new Meadow.Desktop project:

```console
dotnet new Desktop --name WindowsDemo
dotnet new meadow-desktop --name WindowsDemo
```

This Meadow.Desktop application opens a 320x240 pixel window saying `Hello, World` using [MicroLayout](../../../Meadow.Foundation/Libraries_and_Frameworks/MicroLayout/index.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode and in a new Terminal within, enter the following command to create a new Meadow F7 Feather project:

```console
dotnet new CoreComputeModule --name CcmDemo
dotnet new meadow-ccm --name CcmDemo
```

What this Meadow application does is creates an `RgbPwmLed` object on the CCM Dev Kit's onboard RGB LED and cycles through different colors.
Expand Down
20 changes: 10 additions & 10 deletions docs/Meadow/Getting_Started/MCUs/F7_Feather/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode and in a new Terminal within, enter the following command to create a new Meadow F7 Feather project:

```console
dotnet new F7Feather --name F7FeatherDemo
dotnet new meadow-feather --name F7FeatherDemo
```

This Meadow application creates a `RgbPwmLed` object that represents the onboard RGB LED and cycles through different colors.
Expand Down Expand Up @@ -203,14 +203,14 @@ The following template packages will be installed:
Success: WildernessLabs.Meadow.Template installed the following templates:
Template Name Short Name Language Tags
----------------------------- ----------------- -------------- --------------
Meadow Core-Compute App CoreComputeModule [C#],F#,VB.NET Meadow/Console
Meadow F7 Feather App F7Feather [C#],F#,VB.NET Meadow/Console
Meadow Library Library [C#],F#,VB.NET Meadow/Library
Meadow Project Lab App ProjectLab [C#] Meadow/Console
Meadow.Desktop App MeadowDesktop [C#] Meadow/Console
Meadow.Linux Jetson Nano App JetsonNano [C#] Meadow/Console
Meadow.Linux Raspberry Pi App RaspberryPi [C#] Meadow/Console
Meadow.Linux reTerminal App reTerminal [C#] Meadow/Console
Meadow Core-Compute App meadow-ccm [C#],F#,VB.NET Meadow/Console
Meadow F7 Feather App meadow-feather [C#],F#,VB.NET Meadow/Console
Meadow Library meadow-library [C#],F#,VB.NET Meadow/Library
Meadow Project Lab App meadow-project-lab [C#] Meadow/Console
Meadow.Desktop App meadow-desktop [C#] Meadow/Console
Meadow.Linux Jetson Nano App meadow-jetson-nano [C#] Meadow/Console
Meadow.Linux Raspberry Pi App meadow-raspberry-pi [C#] Meadow/Console
Meadow.Linux reTerminal App meadow-reterminal [C#] Meadow/Console
```

### Step 5 - Create your first Meadow application
Expand All @@ -220,7 +220,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open a console or terminal and enter the following command to create a new Meadow F7 Feather project:

```console
dotnet new F7Feather --name F7FeatherDemo
dotnet new meadow-feather --name F7FeatherDemo
```

This Meadow application creates a `RgbPwmLed` object representing the onboard RGB LED and cycles through different colors.
Expand Down
77 changes: 76 additions & 1 deletion docs/Meadow/Getting_Started/MCUs/Project_Lab/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Lets verify everything is set up by deploying your first Meadow application.
Open VSCode and in a new Terminal within, enter the following command to create a new Project Lab project:

```console
dotnet new ProjectLab --name ProjectLabDemo
dotnet new meadow-project-lab --name ProjectLabDemo
```

This project creates a Project Lab demo app that will activate all its onboard sensors (environmental, light and motion sensors, button states) and show its readings periodically on its 320x240 SPI display.
Expand Down Expand Up @@ -169,5 +169,80 @@ You can check more samples in our [Meadow.Samples](https://github.com/Wilderness

![Meadow.Project.Samples GitHub Repository](wilderness-labs-meadow-projectlab-samples.jpg)

</TabItem>
<TabItem value="meadowcli" label="Meadow CLI">

### Step 1 - Install .NET Runtime

Download and install the latest version of the [.NET runtime](https://dotnet.microsoft.com/en-us/download).

### Step 2 - Install Meadow CLI

Download and Install [Meadow CLI](https://www.nuget.org/packages/WildernessLabs.Meadow.CLI//) if it's not installed already.

### Step 3 - Deploy latest version of Meadow.OS

Use the [Meadow.CLI](../../../Meadow_Tools/Meadow_CLI/) to deploy [Meadow.OS](../../Deploying_Meadow%2EOS/) to your board to ensure it’s running with the latest version available.

### Step 4 - Install Meadow Project Templates

Open a console window and enter the following command to install a list of Meadow project templates:

```console
dotnet new install WildernessLabs.Meadow.Template
```

When installed, you’ll see a list of templates available:

```console
The following template packages will be installed:
WildernessLabs.Meadow.Template

Success: WildernessLabs.Meadow.Template installed the following templates:
Template Name Short Name Language Tags
----------------------------- ----------------- -------------- --------------
Meadow Core-Compute App meadow-ccm [C#],F#,VB.NET Meadow/Console
Meadow F7 Feather App meadow-feather [C#],F#,VB.NET Meadow/Console
Meadow Library meadow-library [C#],F#,VB.NET Meadow/Library
Meadow Project Lab App meadow-project-lab [C#] Meadow/Console
Meadow.Desktop App meadow-desktop [C#] Meadow/Console
Meadow.Linux Jetson Nano App meadow-jetson-nano [C#] Meadow/Console
Meadow.Linux Raspberry Pi App meadow-raspberry-pi [C#] Meadow/Console
Meadow.Linux reTerminal App meadow-reterminal [C#] Meadow/Console
```

### Step 5 - Create your first Meadow application

Lets verify everything is set up by deploying your first Meadow application.

Open VSCode and in a new Terminal within, enter the following command to create a new Project Lab project:

```console
dotnet new meadow-project-lab --name ProjectLabDemo
```

This project creates a Project Lab demo app that will activate all its onboard sensors (environmental, light and motion sensors, button states) and show its readings periodically on its 320x240 SPI display.

### Step 6 - Deploy your application

With no code changes, let's deploy this app to your new board.

Again in your console window, use the `meadow app run` command to build, trim, deploy and start your Meadow application.

:::caution
When deploying a project for the first time, the transfer will take several minutes, since it's transferring all the necessary libraries to run the application. Once the app is running for the first time, deployment will be faster as it will transfer only the files that have been changed.
:::

Once all the files are transferred to your device, the app will start in debug mode and you should see your Project Lab loading up a screen with all the sensor values refreshing every few seconds. You can also press the push buttons and see their status change right away.

![Project Lab app running](wildernesslabs_projectlab_blinky.gif)

### Step 7 - Check out additional samples

You can check more samples in our [Meadow.Samples](https://github.com/WildernessLabs/Meadow.Samples/tree/main) GitHub repo.

![Meadow.Samples GitHub Repository](./wilderness-labs-meadow-projectlab-samples.jpg)


</TabItem>
</Tabs>
Loading

0 comments on commit 5877cbd

Please sign in to comment.