Skip to content

Commit 3c62bd2

Browse files
authored
Fix doc regression and non-existent links (#99)
1 parent cfb4721 commit 3c62bd2

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

docs/led-blinker.md

+13-15
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ This is designed to be an extended introductory F´ tutorial taking the user thr
1313

1414
In order to run through this tutorial, you must first do the following:
1515

16-
1. Meet the [F´ System Requirements](https://fprime.jpl.nasa.gov/latest/getting-started/installing-fprime#system-requirements)
16+
1. Meet the [F´ System Requirements](https://github.com/nasa/fprime?tab=readme-ov-file#system-requirements)
1717
2. Install an IDE or text editor supporting copy-paste. [VSCode](https://code.visualstudio.com/) has [plugins](https://marketplace.visualstudio.com/items?itemName=jet-propulsion-laboratory.fpp) to work with FPP.
18-
3. Attempt the [Hello World Tutorial](https://fprime.jpl.nasa.gov/latest/tutorials-hello-world/docs/hello-world/)
18+
3. Attempt the [Hello World Tutorial](https://fprime-community.github.io/fprime-tutorial-hello-world/)
1919

2020
> [!IMPORTANT]
2121
> If you do not have the hardware, you can still follow the LED Blinker tutorial! You should just skip the Hardware sections.
2222
2323
To run on hardware with cross-compiling, you must also:
2424

2525
1. Acquire and set up the appropriate hardware as described in the [Appendix: Optional Hardware Requirement](#appendix-optional-hardware-requirements) section
26-
2. Set up a [cross-compiling environment](https://fprime.jpl.nasa.gov/latest/documentation/tutorials/cross-compilation#cross-compilation-setup) for their ARM processor
26+
2. Set up a [cross-compiling environment](https://nasa.github.io/fprime/Tutorials/CrossCompilationSetup/CrossCompilationSetupTutorial.html) for their ARM processor
2727

2828
> [!NOTE]
2929
> Attendees to an in-person F´ workshop will have access to 64-bit ARM hardware and should set up the 64-bit cross compiling environment.
@@ -48,15 +48,13 @@ This tutorial is composed of the following steps:
4848
## 1. LED Blinker: Project Setup
4949

5050
> [!NOTE]
51-
> If you have followed the [HelloWorld tutorial](https://fprime.jpl.nasa.gov/latest/tutorials-hello-world/docs/hello-world/) previously, this should feel very familiar...
51+
> If you have followed the [HelloWorld tutorial](https://fprime-community.github.io/fprime-tutorial-hello-world/) previously, this should feel very familiar...
5252
5353
An F´ Project ties to a specific version of tools to work with F´. In order to create
54-
this project and install the correct version of tools, you should perform a bootstrap of F´.
54+
this project and install the correct version of tools, you should perform a bootstrap of F´:
5555

56-
To do this you should follow the following steps from the [F´ installation guide](https://fprime.jpl.nasa.gov/latest/getting-started/installing-fprime):
57-
58-
1. Ensure you meet the [F´ System Requirements](https://fprime.jpl.nasa.gov/latest/getting-started/installing-fprime#requirements)
59-
2. [Bootstrap your F´ project](https://fprime.jpl.nasa.gov/latest/getting-started/installing-fprime#creating-a-new-f-project) with the name `led-blinker`
56+
1. Ensure you meet the [F´ System Requirements](https://github.com/nasa/fprime?tab=readme-ov-file#system-requirements)
57+
2. [Bootstrap your F´ project](https://nasa.github.io/fprime/INSTALL.html#creating-a-new-f-project) with the name `led-blinker`
6058

6159
Bootstrapping your F´ project created a folder called `led-blinker` (or any name you chose) containing the standard F´ project structure as well as the virtual environment up containing the tools to work with F´.
6260

@@ -1073,12 +1071,12 @@ Congratulations you've now run on hardware. The final section of this tutorial i
10731071

10741072
In this section, we will walk through the creation of system tests, also known as integration tests, for the LED component created in prior steps.
10751073

1076-
F Prime system tests use a python api to dispatch commands to a deployment using the fprime GDS, verifying components behave as expected as part of deployment running on actual hardware.
1074+
F Prime system tests use a Python API to dispatch commands to a deployment using the GDS, verifying components behave as expected as part of deployment running on actual hardware.
10771075

1078-
Before starting this guide, users should have the LedBlinking deployment running on their hardware and connected to the fprime GDS running on a development machine. If hardware is not available, this guide can be followed by running the LedBlinking deployment locally on a development machine instead.
1076+
Before starting this guide, users should have the LedBlinking deployment running on their hardware and connected to the GDS running on a development machine. If hardware is not available, this guide can be followed by running the LedBlinking deployment locally on a development machine instead.
10791077

10801078
> [!NOTE]
1081-
> If running the LedBlinker deployment locally instead of on the intended hardware, make sure to rebuild fprime with stubbed GPIO drivers so the LedBlinker deployment doesn't attempt to write to physical GPIO ports. Regenerate the native deployment with `fprime-util generate -DFPRIME_USE_STUBBED_DRIVERS=ON`. MacOS defaults to stubbed drivers and does not require explicitly setting this option.
1079+
> If running the LedBlinker deployment locally instead of on the intended hardware, make sure to rebuild with stubbed GPIO drivers so the LedBlinker deployment doesn't attempt to write to physical GPIO ports. Regenerate the native deployment with `fprime-util generate -DFPRIME_USE_STUBBED_DRIVERS=ON`. MacOS defaults to stubbed drivers and does not require explicitly setting this option.
10821080
10831081
### Intro to F Prime System Testing
10841082

@@ -1103,7 +1101,7 @@ def test_cmd_no_op(fprime_test_api):
11031101

11041102
This test will send a `CMD_NO_OP` command and verify if successfully returns.
11051103

1106-
Next, after verifying the fprime GDS is connected to your deployment, run the new system test and confirm it executes successfully.
1104+
Next, after verifying the GDS is connected to your deployment, run the new system test and confirm it executes successfully.
11071105

11081106
```shell
11091107
# In led-blinker/LedBlinker
@@ -1113,7 +1111,7 @@ $ pytest ../Components/Led/test/int/led_integration_tests.py
11131111

11141112
### F Prime System Testing Assertions
11151113

1116-
The typical pattern for fprime system tests is to send a command, then wait until some condition is met, such as receiving an event. If the system test don't receive the expected results, they will time out and fail.
1114+
The typical pattern for system tests is to send a command, then wait until some condition is met, such as receiving an event. If the system test don't receive the expected results, they will time out and fail.
11171115

11181116
`fprime_test_api.send_and_assert_command` will send a command and wait for its completion, but there are several other variants we will use in this guide.
11191117

@@ -1189,7 +1187,7 @@ Run `pytest` again. **Notice that this new telemetry check should fail.**
11891187
#TODO: use fprime_test_api.assert_telemetry to check that "LedBlinker.led.BlinkingState" is off
11901188
```
11911189

1192-
Events in fprime are emitted immediately, but telemetry is only emitted periodically. In the LedBlinker deployment, telemetry channels are sent once per second.
1190+
Events in are emitted immediately, but telemetry is only emitted periodically. In the LedBlinker deployment, telemetry channels are sent once per second.
11931191

11941192
The `fprime_test_api.assert_telemetry` check will immediately search for a matching `LedBlinker.led.BlinkingState` telemetry value.
11951193
However, because one second hasn't passed between setting blinking off and checking for telemetry, there hasn't been sufficient time for the updated telemetry value to be sent.

0 commit comments

Comments
 (0)