X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=doc%2Faltos.xsl;h=5b9e12e8fa4b84d63f24558d9f54d9113e6e98b8;hb=bb72b4018dd6a422afe1916d9538bb9ff1e45353;hp=5af94725603705ccc429beac72dadf272a40fe88;hpb=aa7eac32adf4c2cdf441991d02411758f2682d1e;p=fw%2Faltos
diff --git a/doc/altos.xsl b/doc/altos.xsl
index 5af94725..5b9e12e8 100644
--- a/doc/altos.xsl
+++ b/doc/altos.xsl
@@ -265,16 +265,22 @@
will fail to compile.
+
AO_EXTI_MODE_PULL_UP. Apply a pull-up to the pin; a
disconnected pin will read as 1.
+
+
AO_EXTI_MODE_PULL_DOWN. Apply a pull-down to the pin;
a disconnected pin will read as 0.
+
+
0. Don't apply either a pull-up or pull-down. A
disconnected pin will read an undetermined value.
+
@@ -1005,7 +1011,7 @@
variable with one of the following values:
- ao_cmd_success
+ ao_cmd_success
The command was parsed successfully. There is no
@@ -1014,7 +1020,7 @@
- ao_cmd_lex_error
+ ao_cmd_lex_error
A token in the line was invalid, such as a number
@@ -1024,7 +1030,7 @@
- ao_syntax_error
+ ao_syntax_error
The command line is invalid for some reason other
@@ -1323,57 +1329,60 @@
CC1111 Radio peripheral
-
- The CC1111 radio transceiver sends and receives digital packets
- with forward error correction and detection. The AltOS driver is
- fairly specific to the needs of the TeleMetrum and TeleDongle
- devices, using it for other tasks may require customization of
- the driver itself. There are three basic modes of operation:
-
-
-
- Telemetry mode. In this mode, TeleMetrum transmits telemetry
- frames at a fixed rate. The frames are of fixed size. This
- is strictly a one-way communication from TeleMetrum to
- TeleDongle.
-
-
-
-
- Packet mode. In this mode, the radio is used to create a
- reliable duplex byte stream between TeleDongle and
- TeleMetrum. This is an asymmetrical protocol with
- TeleMetrum only transmitting in response to a packet sent
- from TeleDongle. Thus getting data from TeleMetrum to
- TeleDongle requires polling. The polling rate is adaptive,
- when no data has been received for a while, the rate slows
- down. The packets are checked at both ends and invalid
- data are ignored.
-
-
- On the TeleMetrum side, the packet link is hooked into the
- stdio mechanism, providing an alternate data path for the
- command processor. It is enabled when the unit boots up in
- 'idle' mode.
-
-
- On the TeleDongle side, the packet link is enabled with a
- command; data from the stdio package is forwarded over the
- packet link providing a connection from the USB command
- stream to the remote TeleMetrum device.
-
-
-
-
- Radio Direction Finding mode. In this mode, TeleMetrum
- constructs a special packet that sounds like an audio tone
- when received by a conventional narrow-band FM
- receiver. This is designed to provide a beacon to track
- the device when other location mechanisms fail.
-
-
-
-
+
+ Radio Introduction
+
+ The CC1111 radio transceiver sends and receives digital packets
+ with forward error correction and detection. The AltOS driver is
+ fairly specific to the needs of the TeleMetrum and TeleDongle
+ devices, using it for other tasks may require customization of
+ the driver itself. There are three basic modes of operation:
+
+
+
+ Telemetry mode. In this mode, TeleMetrum transmits telemetry
+ frames at a fixed rate. The frames are of fixed size. This
+ is strictly a one-way communication from TeleMetrum to
+ TeleDongle.
+
+
+
+
+ Packet mode. In this mode, the radio is used to create a
+ reliable duplex byte stream between TeleDongle and
+ TeleMetrum. This is an asymmetrical protocol with
+ TeleMetrum only transmitting in response to a packet sent
+ from TeleDongle. Thus getting data from TeleMetrum to
+ TeleDongle requires polling. The polling rate is adaptive,
+ when no data has been received for a while, the rate slows
+ down. The packets are checked at both ends and invalid
+ data are ignored.
+
+
+ On the TeleMetrum side, the packet link is hooked into the
+ stdio mechanism, providing an alternate data path for the
+ command processor. It is enabled when the unit boots up in
+ 'idle' mode.
+
+
+ On the TeleDongle side, the packet link is enabled with a
+ command; data from the stdio package is forwarded over the
+ packet link providing a connection from the USB command
+ stream to the remote TeleMetrum device.
+
+
+
+
+ Radio Direction Finding mode. In this mode, TeleMetrum
+ constructs a special packet that sounds like an audio tone
+ when received by a conventional narrow-band FM
+ receiver. This is designed to provide a beacon to track
+ the device when other location mechanisms fail.
+
+
+
+
+
ao_radio_set_telemetry
@@ -1463,14 +1472,16 @@
the radio operation.
-
- In telemetry mode, you can send or receive a telemetry
- packet. The data from receiving a packet also includes the RSSI
- and status values supplied by the receiver. These are added
- after the telemetry data.
-
- ao_radio_send
+ Radio Telemetry
+
+ In telemetry mode, you can send or receive a telemetry
+ packet. The data from receiving a packet also includes the RSSI
+ and status values supplied by the receiver. These are added
+ after the telemetry data.
+
+
+ ao_radio_send
void
ao_radio_send(__xdata struct ao_telemetry *telemetry);
@@ -1482,9 +1493,9 @@
sending, and ao_radio_put() afterwards, to correctly
serialize access to the radio device.
-
-
+
+ ao_radio_recv
void
ao_radio_recv(__xdata struct ao_radio_recv *radio);
@@ -1498,13 +1509,16 @@
received, or zero if the operation was aborted (from some
other task calling ao_radio_abort()).
+
-
- In radio direction finding mode, there's just one function to
- use
-
- ao_radio_rdf
+ Radio Direction Finding
+
+ In radio direction finding mode, there's just one function to
+ use
+
+
+ ao_radio_rdf
void
ao_radio_rdf(int ms);
@@ -1513,15 +1527,18 @@
This sends an RDF packet lasting for the specified amount
of time. The maximum length is 1020 ms.
+
-
- Packet mode is asymmetrical and is configured at compile time
- for either master or slave mode (but not both). The basic I/O
- functions look the same at both ends, but the internals are
- different, along with the initialization steps.
-
- ao_packet_putchar
+ Radio Packet Mode
+
+ Packet mode is asymmetrical and is configured at compile time
+ for either master or slave mode (but not both). The basic I/O
+ functions look the same at both ends, but the internals are
+ different, along with the initialization steps.
+
+
+ ao_packet_putchar
void
ao_packet_putchar(char c);
@@ -1534,9 +1551,9 @@
slave side, any pending data will be sent the next time
the master polls for data.
-
-
+
+ ao_packet_pollchar
char
ao_packet_pollchar(void);
@@ -1546,9 +1563,9 @@
otherwise returns AO_READ_AGAIN. On the master side, if
this empties the buffer, it triggers a poll for more data.
-
-
- ao_packet_slave_start
+
+
+ ao_packet_slave_start
void
ao_packet_slave_start(void);
@@ -1557,9 +1574,9 @@
This is available only on the slave side and starts a task
to listen for packet data.
-
-
+
+ ao_packet_slave_stop
void
ao_packet_slave_stop(void);
@@ -1567,9 +1584,9 @@
Disables the packet slave task, stopping the radio receiver.
-
-
+
+ ao_packet_slave_init
void
ao_packet_slave_init(void);
@@ -1579,9 +1596,9 @@
that when packet slave mode is enabled, characters will
get send and received through the stdio functions.
-
-
- ao_packet_master_init
+
+
+ ao_packet_master_init
void
ao_packet_master_init(void);
@@ -1589,6 +1606,7 @@
Adds the 'p' packet forward command to start packet mode.
+