Skip to content

Commit

Permalink
Merge pull request #707 from WildernessLabs/develop
Browse files Browse the repository at this point in the history
deploy 3.5.2024
  • Loading branch information
adunndevster2 authored Mar 5, 2024
2 parents b9315ad + 440d9e7 commit 0a4105c
Show file tree
Hide file tree
Showing 25 changed files with 103 additions and 21 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/Meadow/Getting_Started/Assemble_Meadow/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ Additionally, you could get metal or nylon fasteners so you screw them in the co

Congratulations, your Meadow developer kit assembled and now you're ready to test the Meadow board on the next section.

## [Next - Deploy Meadow OS](/Meadow/Getting_Started/Deploying_Meadow/)
## [Next - Deploy Meadow OS](/Meadow/Getting_Started/Deploying_Meadow%2EOS/)
6 changes: 6 additions & 0 deletions docs/Meadow/Getting_Started/Deploying_Meadow/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
layout: Meadow
title: Meadow OS Deployment
---

This content has moved: [**Getting Started** > **Deploying Meadow.OS**](/Meadow/Getting_Started/Deploying_Meadow%2EOS/).
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Getting started with the [Meadow Core-Compute module](https://store.wildernessla
If you are working with a bare Meadow Core-Compute module without the development kit, you will likely want to connect the castellated pins to peripherals to be able to move beyond logging or code-only projects. For production builds, the Core-Compute board on its own doesn't include an onboard LED to interact with.

1. **Install Visual Studio** - Download and Install [Visual Studio 2022](https://visualstudio.microsoft.com/) for either Windows or macOS to prepare your development machine. Community edition will work fine.
1. **Deploy Meadow.OS** - Use the Meadow.CLI to [deploy Meadow.OS to your board](/Meadow/Getting_Started/Deploying_Meadow/), booting the Core-Compute module into bootloader mode when you first connect it to your development machine.
1. **Deploy Meadow.OS** - Use the Meadow.CLI to [deploy Meadow.OS to your board](/Meadow/Getting_Started/Deploying_Meadow%2EOS/), booting the Core-Compute module into bootloader mode when you first connect it to your development machine.
1. **Deploy Hello, World** - Verify everything is setup by deploying your first Meadow application. You can start working from the Feather [Hello, Meadow](/Meadow/Getting_Started/MCUs/F7_Feather/) application, but you will need to connect external components or peripherals to recreate the experience of the onboard RGB LED. You can still see logging output without any additional components.

```csharp
Expand Down
6 changes: 3 additions & 3 deletions docs/Meadow/Getting_Started/Hello_World/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Hello, Meadow!
subtitle: Create, deploy, and understand your first Meadow application.
---

Once [Meadow.OS has been deployed to your board](/Meadow/Getting_Started/Deploying_Meadow), you can create and deploy Meadow apps to it.
Once [Meadow.OS has been deployed to your board](/Meadow/Getting_Started/Deploying_Meadow%2EOS/), you can create and deploy Meadow apps to it.

The video below shows you how to create and deploy your first Meadow app on a Mac:
<p><iframe width="640" height="360" src="https://www.youtube.com/embed/wkekz5I7ycE" frameborder="3" allowfullscreen></iframe></p>
Expand Down Expand Up @@ -52,7 +52,7 @@ You'll need to install the VS Tools for Meadow Extension by [downloading it](htt

### Step 3: Deploy your Application

The Meadow application template is a simple application that will pulse the onboard LED. As long as the [Meadow.OS is deployed to your Meadow board](/Meadow/Getting_Started/Deploying_Meadow), you can use the same techniques to deploy a Meadow application as you would any other .NET application:
The Meadow application template is a simple application that will pulse the onboard LED. As long as the [Meadow.OS is deployed to your Meadow board](/Meadow/Getting_Started/Deploying_Meadow%2EOS), you can use the same techniques to deploy a Meadow application as you would any other .NET application:

1. Connect your Meadow device to your development machine
2. Right-click anywhere in the toolbar area and you'll see _Meadow Device List_ in the dropdown. Click on it and it will be added to your toolbar. (Alternatively, you can show the list from the **View** > **Toolbars** > **Meadow Device List** menu entry.)
Expand Down Expand Up @@ -115,7 +115,7 @@ To fix this do the following:

### Step 3: Deploy your Application

The Meadow application template is a simple application that will pulse the onboard LED. As long as the [Meadow.OS is deployed to your Meadow board](/Meadow/Getting_Started/Deploying_Meadow), you can use the same techniques to deploy a Meadow application as you would any other .NET application:
The Meadow application template is a simple application that will pulse the onboard LED. As long as the [Meadow.OS is deployed to your Meadow board](/Meadow/Getting_Started/Deploying_Meadow%2EOS), you can use the same techniques to deploy a Meadow application as you would any other .NET application:

1. Connect your Meadow device to your development machine
2. Press the **Play** button in Visual Studio to compile and deploy your application
Expand Down
6 changes: 3 additions & 3 deletions docs/Meadow/Getting_Started/Setup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ subtitle: Guides and documentation for Meadow

# Configuring the Meadow Build Environment

1. [Connect Meadow to the ST-Link V2](stlink/)
* Configure Your Development Environment:
1. [Connect Meadow to the ST-Link V2](stlink/)
* Configure Your Development Environment:
* [macOS](macos/)
* [Windows](Windows/)

## [Next - Deploy Meadow OS](/Meadow/Getting_Started/Deploying_Meadow/)
## [Next - Deploy Meadow OS](/Meadow/Getting_Started/Deploying_Meadow%2EOS/)
2 changes: 1 addition & 1 deletion docs/Meadow/Getting_Started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ subtitle: "To get up and running with Meadow, follow these steps:"

1. Download and Install [Visual Studio 2022](https://visualstudio.microsoft.com/) for either Windows or macOS. Community edition will work fine.
2. [Assemble your Meadow board](/Meadow/Getting_Started/Assemble_Meadow/)
3. Use the Meadow.CLI to [deploy Meadow.OS to your board](/Meadow/Getting_Started/Deploying_Meadow/).
3. Use the Meadow.CLI to [deploy Meadow.OS to your board](/Meadow/Getting_Started/Deploying_Meadow%2EOS/).
4. Deploy a [Hello, Meadow](/Meadow/Getting_Started/MCUs/F7_Feather/) application.
2 changes: 1 addition & 1 deletion docs/Meadow/Meadow.OS/Bluetooth/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ There are several good BLE mobile client applications available from iOS and And

## Pre-requisites

BLE requires your meadow be updated to the latest b5.0 binaries. This includes both a Meadow OS and new firmware for the ESP32. See the [Deploying Meadow.OS Guide](/Meadow/Getting_Started/Deploying_Meadow/) for more information.
BLE requires your meadow be updated to the latest b5.0 binaries. This includes both a Meadow OS and new firmware for the ESP32. See the [Deploying Meadow.OS Guide](/Meadow/Getting_Started/Deploying_Meadow%2EOS/) for more information.

## Defining a BLE Service Definition

Expand Down
12 changes: 6 additions & 6 deletions docs/Meadow/Release_Notes/Beta3/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ Beta 3.11 is a major release that brings a pile of stabilizations and fixes acro

### Updating

You'll need to [flash a new Meadow.OS binary to your device](/Meadow/Getting_Started/Deploying_Meadow/), upgrade your IDE extension(s), and if you use the Meadow.CLI, you'll also need to download and use the latest version of that as well. Follow along with the [Meadow Getting Started guide](/Meadow/Getting_Started/) to get updated.
You'll need to [flash a new Meadow.OS binary to your device](/Meadow/Getting_Started/Deploying_Meadow%2EOS/), upgrade your IDE extension(s), and if you use the Meadow.CLI, you'll also need to download and use the latest version of that as well. Follow along with the [Meadow Getting Started guide](/Meadow/Getting_Started/) to get updated.

### Meadow.OS Changes

Expand Down Expand Up @@ -233,7 +233,7 @@ Beta 3.10 is a cleanup release to fix several regressions introduced in `b3.8` a

### Updating

You'll need to [flash a new Meadow.OS binary to your device](/Meadow/Getting_Started/Deploying_Meadow/), upgrade your IDE extension(s), and if you use the Meadow.CLI, you'll also need to download and use the latest version of that as well. Follow along with the [Meadow Getting Started guide](/Meadow/Getting_Started/) to get updated.
You'll need to [flash a new Meadow.OS binary to your device](/Meadow/Getting_Started/Deploying_Meadow%2EOS/), upgrade your IDE extension(s), and if you use the Meadow.CLI, you'll also need to download and use the latest version of that as well. Follow along with the [Meadow Getting Started guide](/Meadow/Getting_Started/) to get updated.

### Additional Free Serial Port

Expand Down Expand Up @@ -266,7 +266,7 @@ This release includes bug fixes and performance improvements in several drivers.

### Updating

You'll need to [flash a new Meadow.OS binary to your device](/Meadow/Getting_Started/Deploying_Meadow/), upgrade your IDE extension(s), and if you use the Meadow.CLI, you'll also need to download and use the latest version of that as well. Follow along with the [Meadow Getting Started guide](/Meadow/Getting_Started/) to get updated.
You'll need to [flash a new Meadow.OS binary to your device](/Meadow/Getting_Started/Deploying_Meadow%2EOS/), upgrade your IDE extension(s), and if you use the Meadow.CLI, you'll also need to download and use the latest version of that as well. Follow along with the [Meadow Getting Started guide](/Meadow/Getting_Started/) to get updated.

### New Features & Changes

Expand Down Expand Up @@ -302,7 +302,7 @@ This is another point release but it gets us another step closer to `b4.0`. The

### Updating

You'll need to [flash a new Meadow.OS binary to your device](/Meadow/Getting_Started/Deploying_Meadow/), upgrade your IDE extension(s), and if you use the Meadow.CLI, you'll also need to download and use the latest version of that as well. Follow along with the [Meadow Getting Started guide](/Meadow/Getting_Started/) to get updated.
You'll need to [flash a new Meadow.OS binary to your device](/Meadow/Getting_Started/Deploying_Meadow%2EOS/), upgrade your IDE extension(s), and if you use the Meadow.CLI, you'll also need to download and use the latest version of that as well. Follow along with the [Meadow Getting Started guide](/Meadow/Getting_Started/) to get updated.

### Bug Fixes

Expand Down Expand Up @@ -338,7 +338,7 @@ Though this is a point release, it's actually cut from the `b4.0` work, and repr

### Updating

You'll need to [flash a new Meadow.OS binary to your device](/Meadow/Getting_Started/Deploying_Meadow/), upgrade your IDE extension(s), and if you use the Meadow.CLI, you'll also need to download and use the latest version of that as well. Follow along with the [Meadow Getting Started guide](/Meadow/Getting_Started/) to get updated.
You'll need to [flash a new Meadow.OS binary to your device](/Meadow/Getting_Started/Deploying_Meadow%2EOS/), upgrade your IDE extension(s), and if you use the Meadow.CLI, you'll also need to download and use the latest version of that as well. Follow along with the [Meadow Getting Started guide](/Meadow/Getting_Started/) to get updated.

### Performance Improvements

Expand Down Expand Up @@ -632,7 +632,7 @@ We upgraded the file system that Meadow uses to LittleFS; which has the distinct

Now, after when you deploy Meadow.OS, the first startup should be very fast, and you won't need to wait for the flash to format.

To upgrade, you'll need to [flash the latest version of Meadow.OS](/Meadow/Getting_Started/Deploying_Meadow/) to your device.
To upgrade, you'll need to [flash the latest version of Meadow.OS](/Meadow/Getting_Started/Deploying_Meadow%2EOS/) to your device.

### Basic Analog Input is Up

Expand Down
6 changes: 3 additions & 3 deletions docs/Meadow/Release_Notes/Beta4/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This is another tiny release to address an issue when connecting to a WiFi netwo

## Updating

This release requires a Meadow.OS firmware update (follow steps [here](/Meadow/Getting_Started/Deploying_Meadow/)), no IDE or Meadow.CLI updates are necessary.
This release requires a Meadow.OS firmware update (follow steps [here](/Meadow/Getting_Started/Deploying_Meadow%2EOS/)), no IDE or Meadow.CLI updates are necessary.

# b4.6.1

Expand Down Expand Up @@ -239,7 +239,7 @@ It also includes some general improvements and bug fixes:

This is a big release with a ton of stability fixes, an overhaul of the CLI, and big new features for networking. Major changes and improvements include:

* **Meadow.OS Flashing from CLI** - We pulled the Meadow.OS firmware uploading out of the Visual Studio IDE and moved it into the CLI for a more unified and reliable Meadow.OS upload experience. [Check out the updated guide](/Meadow/Getting_Started/Deploying_Meadow/).
* **Meadow.OS Flashing from CLI** - We pulled the Meadow.OS firmware uploading out of the Visual Studio IDE and moved it into the CLI for a more unified and reliable Meadow.OS upload experience. [Check out the updated guide](/Meadow/Getting_Started/Deploying_Meadow%2EOS/).
* **WiFi Enumeration Fix** - You can now enumerate WiFi networks without having to first connect to a Network.
* **Faster, More Reliable OS Startup** - Meadow.OS startup is more robust and better handles a mismatch between co-processor firmware or runtime version.
* **Exceptions on Reflection.Emit(ted) code work** - Exceptions via code that was executed from `Reflection.Emit()` now work properly. Previously they would tear down the .NET runtime.
Expand Down Expand Up @@ -364,7 +364,7 @@ Follow along with the [Meadow Getting Started guide](/Meadow/Getting_Started/) t
Unzip everything to a common folder, the instructions below assume the OS and network binaries are in the same folder and the CLI is in a `Meadow.CLI` subfolder relative to the OS binaries.

Open a terminal window and execute the following steps. Please note that if you don't have DFU-Util
installed, you can find instructions on how to install it [here](/Meadow/Getting_Started/Deploying_Meadow/).
installed, you can find instructions on how to install it [here](/Meadow/Getting_Started/Deploying_Meadow%2EOS/).

1. Connect Meadow in normal mode
1. Disable mono (may need to run twice if you get an exception the first time).
Expand Down
2 changes: 1 addition & 1 deletion docs/Meadow/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ subtitle: Guides and documentation for Meadow devices and applications.
If you're just beginning, check out the [Getting Started](/Meadow/Getting_Started) walkthrough to get your development environment configured and deploy your first Meadow application:

* [Assembling your Meadow board](/Meadow/Getting_Started/Assemble_Meadow)
* [Deploying Meadow OS](/Meadow/Getting_Started/Deploying_Meadow)
* [Deploying Meadow OS](/Meadow/Getting_Started/Deploying_Meadow%2EOS)
* [Hello, Meadow](/Meadow/Getting_Started/Hello_World)

## Meadow Basics
Expand Down
40 changes: 39 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,45 @@ const config = {
],
},

plugins: ["docusaurus-plugin-sass"],
plugins: [
"docusaurus-plugin-sass",
[
"@docusaurus/plugin-client-redirects",
{
// fromExtensions: ["html", "htm"], // /myPage.html -> /myPage
// toExtensions: ["exe", "zip"], // /myAsset -> /myAsset.zip (if latter exists)
redirects: [
{
to: "/Hardware/Reference/Electronic_Fundamentals/Voltage/",
from: "/Hardware/Reference/Equations_and_Laws/Voltage/",
},

{
to: "/Hardware/Reference/Components/Common/",
from: "/Hardware/Ciruits/Components/",
},
{
to: "/Hardware/Reference/Components/Common/Capacitors",
from: "/Hardware/Ciruits/Components/Capacitors",
},
{
to: "/Hardware/Reference/Components/Common/Diodes",
from: "/Hardware/Ciruits/Components/Diodes",
},
{
to: "/Hardware/Reference/Components/Common/Resistors/",
from: "/Hardware/Ciruits/Components/Resistors/",
},

// // Redirect from multiple old paths to the new path
// {
// to: "/docs/newDoc2",
// from: ["/docs/oldDocFrom2019", "/docs/legacyDocFrom2016"],
// },
],
},
],
],

// Set the production url of your site here
url: "https://developer.wildernesslabs.co/",
Expand Down
37 changes: 37 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
},
"dependencies": {
"@docusaurus/core": "2.4.3",
"@docusaurus/plugin-client-redirects": "^2.4.3",
"@docusaurus/preset-classic": "2.4.3",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.2.1",
Expand Down

0 comments on commit 0a4105c

Please sign in to comment.