Skip to content

Commit 088d390

Browse files
committed
TUTORIAL.md Adjust firmware dependency notes after V1.15 realease.
1 parent 6e93221 commit 088d390

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

v3/docs/TUTORIAL.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -892,6 +892,8 @@ asyncio.run(queue_go(4))
892892

893893
## 3.6 ThreadSafeFlag
894894

895+
This requires firmware V1.15 or later.
896+
895897
This official class provides an efficient means of synchronising a task with a
896898
truly asynchronous event such as a hardware interrupt service routine or code
897899
running in another thread. It operates in a similar way to `Event` with the
@@ -974,11 +976,6 @@ tasks may wait on that `Event`. As an alternative to explicitly coding this,
974976
the [Message class](./TUTORIAL.md#39-message) uses this approach to provide an
975977
`Event`-like object which can be triggered from an ISR.
976978

977-
#### Note
978-
979-
ThreadSafeFlag is only available in nightly builds. It will be available in
980-
release builds starting with V1.15.
981-
982979
###### [Contents](./TUTORIAL.md#contents)
983980

984981
## 3.7 Barrier
@@ -1188,6 +1185,8 @@ finally:
11881185

11891186
## 3.9 Message
11901187

1188+
This requires firmware V1.15 or later.
1189+
11911190
This is an unofficial primitive with no counterpart in CPython asyncio. It uses
11921191
[ThreadSafeFlag](./TUTORIAL.md#36-threadsafeflag) to provide an object similar
11931192
to `Event` but capable of being set in a hard ISR context. It extends
@@ -1275,11 +1274,6 @@ async def main():
12751274
asyncio.run(main())
12761275
```
12771276

1278-
#### ThreadSafeFlag dependency
1279-
1280-
ThreadSafeFlag is only available in nightly builds. It will be available in
1281-
release builds starting with V1.15.
1282-
12831277
## 3.10 Synchronising to hardware
12841278

12851279
The following hardware-related classes are documented [here](./DRIVERS.md):

0 commit comments

Comments
 (0)