Skip to contentSkip to conversation

website: introduce asciidoc website generation framework

PATCH New Alexander Aring 3 participants 7 messages Dec 12, 2014 IEEE 802.15.4

lore
Share & tools
lore

Alexander Aring

author maintainer
#0 lore raw

PATCH 1/1 website: introduce asciidoc website generation framework

Hi,

this series introduce some files to build some website with asciidoc. Feel free to add own information and then we simple update the website of
http://wpan.cakelab.org/.

- Alex

Alexander Aring (1):
website: inital commit

 website/.gitingore |   1 +
 website/Makefile   |   5 +++
 website/index.txt  | 128 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 134 insertions(+)
 create mode 100644 website/.gitingore
 create mode 100644 website/Makefile
 create mode 100644 website/index.txt
Signature · 1 line
2.1.3
author maintainer
#1 lore raw

PATCH 1/1 website: inital commit

This is the initial commit for the website asciidoc framework of:

http://wpan.cakelab.org/

---
 website/.gitingore |   1 +
 website/Makefile   |   5 +++
 website/index.txt  | 128 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 134 insertions(+)
 create mode 100644 website/.gitingore
 create mode 100644 website/Makefile
 create mode 100644 website/index.txt
website/.gitingore new file +1 -0
new file mode 100644
index 0000000..dcaf716
@@ -0,0 +1 @@
+index.html
website/Makefile new file +5 -0
new file mode 100644
index 0000000..cc090bc
@@ -0,0 +1,5 @@
+all:
+	asciidoc -b html5 -a icons -a toc2 -a theme=flask index.txt
+
+clean:
+	rm index.html
website/index.txt new file +128 -0

128 lines not on this page · raw message

Signature · 1 line
2.1.3
#2 lore raw

Re: [PATCH wpan-misc] website: inital commit

Hello.

Good to see this getting a bit more documented. Some remarks inline.

Quoted 41 lines · Alexander Aring

This is the initial commit for the website asciidoc framework of:

http://wpan.cakelab.org/

---
  website/.gitingore |   1 +
  website/Makefile   |   5 +++
  website/index.txt  | 128
+++++++++++++++++++++++++++++++++++++++++++++++++++++
  3 files changed, 134 insertions(+)

create mode 100644 website/.gitingore
create mode 100644 website/Makefile
create mode 100644 website/index.txt

website/.gitingore new file +1 -0
new file mode 100644
index 0000000..dcaf716
@@ -0,0 +1 @@
+index.html
website/Makefile new file +5 -0
new file mode 100644
index 0000000..cc090bc
@@ -0,0 +1,5 @@
+all:
+	asciidoc -b html5 -a icons -a toc2 -a theme=flask index.txt
+
+clean:
+	rm index.html
website/index.txt new file +2 -0
new file mode 100644
index 0000000..a7ab4bb
@@ -0,0 +1,128 @@
+linux-wpan
+==========

website/index.txt line 12

Quoted 10 lines
website/index.txt new file +10 -0
+Mailinglist <[email protected]>
+
+wpan-tools
+----------
+
+To access the nl802154 netlink inteface you will need the wpan-tools.
+
+Dependencies:
+
+- netlink library http://www.infradead.org/~tgr/libnl/[libnl].

Better name it libnl-3 here as it does not work with libnl-1 and libnl-2

Quoted 27 lines
website/index.txt new file +4 -0
+These tools contains:
+
+[horizontal]
+*iwpan*:: based on the wireless

http://wireless.kernel.org/en/users/Documentation/iw[iw] tool.

website/index.txt new file +4 -0
+
+Download
+~~~~~~~~
+For the last release check out

http://wpan.cakelab.org/releases/[releases] page:

website/index.txt new file +12 -0
+
+http://wpan.cakelab.org/releases/
+
+Supported Hardware
+------------------
+
+.Supported 802.15.4 Hardware
+[cols="3,4,2,^2,12",options="header"]
+|=============================================================
+|Transceiver |Supported        |Driver     | Bus |Where to buy
+|at86rf230   |no               |at86rf230? | SPI |
+|at86rf231   |yes              |at86rf230  | SPI |

http://downloads.qi-hardware.com/people/werner/wpan/web/[atben] Out of stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact
http://en.qi-hardware.com/wiki/Main_Page[qi-hardware].
+|at86rf233 |yes |at86rf230 | SPI |
http://openlabs.co/store/Raspberry-Pi-802.15.4-radio[openlabs]

Quoted 6 lines
+|at86rf212   |yes              |at86rf230  | SPI |
+|atusb       |not mainline yet |atusb      | USB |

http://downloads.qi-hardware.com/people/werner/wpan/web/[atusb] Out of stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact
http://en.qi-hardware.com/wiki/Main_Page[qi-hardware].
+|=============================================================

Maybe mention the other drivers we have mainline here as well? CC2520 and MRF24j40 are fully supported or not?

As a sidenote I build and updated the firmware for my atusb and did some initial testing. Nothing on the RF side yet as I wait for more hardware to test against. I'm willing to bring this driver mainline and update it as needed. So far I only made sure that atusb and at86rf230 share the same header file for register defines to avoid duplication.

Once I have other hardware I will test the RF side of things and start to work on asnyc xmit. Also need to talk to Werner if he is happy with the fw interface. After that I will send out a RFC for it.

regards
Stefan Schmidt

author maintainer
#3 lore raw

Re: [PATCH wpan-misc] website: inital commit

Quoted 50 lines · Stefan Schmidt

Hello.

Good to see this getting a bit more documented. Some remarks inline.

Quoted 45 lines · Alexander Aring

This is the initial commit for the website asciidoc framework of:

http://wpan.cakelab.org/

---
 website/.gitingore |   1 +
 website/Makefile   |   5 +++
 website/index.txt  | 128
+++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 134 insertions(+)
 create mode 100644 website/.gitingore
 create mode 100644 website/Makefile
 create mode 100644 website/index.txt
website/.gitingore new file +1 -0
new file mode 100644
index 0000000..dcaf716
@@ -0,0 +1 @@
+index.html
website/Makefile new file +5 -0
new file mode 100644
index 0000000..cc090bc
@@ -0,0 +1,5 @@
+all:
+	asciidoc -b html5 -a icons -a toc2 -a theme=flask index.txt
+
+clean:
+	rm index.html
website/index.txt new file +6 -0
new file mode 100644
index 0000000..a7ab4bb
@@ -0,0 +1,128 @@
+linux-wpan
+==========
+Mailinglist <[email protected]>
+
+wpan-tools
+----------
Quoted 9 lines

website/index.txt line 12

Quoted 6 lines
website/index.txt new file +6 -0
+
+To access the nl802154 netlink inteface you will need the wpan-tools.
+
+Dependencies:
+
+- netlink library http://www.infradead.org/~tgr/libnl/[libnl].

Better name it libnl-3 here as it does not work with libnl-1 and libnl-2

ok. I thought also about that.

The original iw tool has backwards compat. to older libnl version. We could fix that inside the wpan-tools. But for now indeed libnl-3 is supported only. I will change to it and maybe we have also this backwards compat like iw.

Quoted 28 lines
Quoted 28 lines
website/index.txt new file +4 -0
+These tools contains:
+
+[horizontal]
+*iwpan*:: based on the wireless

http://wireless.kernel.org/en/users/Documentation/iw[iw] tool.

website/index.txt new file +4 -0
+
+Download
+~~~~~~~~
+For the last release check out

http://wpan.cakelab.org/releases/[releases] page:

website/index.txt new file +12 -0
+
+http://wpan.cakelab.org/releases/
+
+Supported Hardware
+------------------
+
+.Supported 802.15.4 Hardware
+[cols="3,4,2,^2,12",options="header"]
+|=============================================================
+|Transceiver |Supported        |Driver     | Bus |Where to buy
+|at86rf230   |no               |at86rf230? | SPI |
+|at86rf231   |yes              |at86rf230  | SPI |

http://downloads.qi-hardware.com/people/werner/wpan/web/[atben] Out of stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact
http://en.qi-hardware.com/wiki/Main_Page[qi-hardware].
+|at86rf233 |yes |at86rf230 | SPI |
http://openlabs.co/store/Raspberry-Pi-802.15.4-radio[openlabs]
+|at86rf212 |yes |at86rf230 | SPI |

Quoted 8 lines
Quoted 5 lines

+|atusb |not mainline yet |atusb | USB |
http://downloads.qi-hardware.com/people/werner/wpan/web/[atusb] Out of stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact
http://en.qi-hardware.com/wiki/Main_Page[qi-hardware].
+|=============================================================

Maybe mention the other drivers we have mainline here as well? CC2520 and MRF24j40 are fully supported or not?

Don't know about these transceivers I have CC2520 here but these are buildin inside some contiki nodes and I don't have any pinout headers for these.

Specially MRF24j40 have some different types and I don't know which type is now supported. The driver maintainers can send patches to linux-wpan and I will apply changes to wpan-misc and generate a new website.

For futher maybe we should add some "features" collumn because many of them doesn't support all driver callbacks.

Quoted 6 lines

As a sidenote I build and updated the firmware for my atusb and did some initial testing. Nothing on the RF side yet as I wait for more hardware to test against. I'm willing to bring this driver mainline and update it as needed. So far I only made sure that atusb and at86rf230 share the same header file for register defines to avoid duplication.

ok.

Quoted 5 lines

Once I have other hardware I will test the RF side of things and start to work on asnyc xmit. Also need to talk to Werner if he is happy with the fw interface. After that I will send out a RFC for it.

ok.

- Alex

maintainer
#4 lore raw

Re: [PATCH wpan-misc] website: inital commit

Hello.

Quoted 59 lines · Alexander Aring
Quoted 49 lines · Stefan Schmidt

Hello.

Good to see this getting a bit more documented. Some remarks inline.

Quoted 44 lines · Alexander Aring

This is the initial commit for the website asciidoc framework of:

http://wpan.cakelab.org/

---
 website/.gitingore |   1 +
 website/Makefile   |   5 +++
 website/index.txt  | 128
+++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 134 insertions(+)
 create mode 100644 website/.gitingore
 create mode 100644 website/Makefile
 create mode 100644 website/index.txt
website/.gitingore new file +1 -0
new file mode 100644
index 0000000..dcaf716
@@ -0,0 +1 @@
+index.html
website/Makefile new file +5 -0
new file mode 100644
index 0000000..cc090bc
@@ -0,0 +1,5 @@
+all:
+	asciidoc -b html5 -a icons -a toc2 -a theme=flask index.txt
+
+clean:
+	rm index.html
website/index.txt new file +5 -0
new file mode 100644
index 0000000..a7ab4bb
@@ -0,0 +1,128 @@
+linux-wpan
+==========
+Mailinglist <[email protected]>
+
+wpan-tools
Quoted 9 lines

website/index.txt line 12

Quoted 7 lines
website/index.txt new file +7 -0
+----------
+
+To access the nl802154 netlink inteface you will need the wpan-tools.
+
+Dependencies:
+
+- netlink library http://www.infradead.org/~tgr/libnl/[libnl].

Better name it libnl-3 here as it does not work with libnl-1 and libnl-2

Quoted 6 lines

ok. I thought also about that.

The original iw tool has backwards compat. to older libnl version. We could fix that inside the wpan-tools. But for now indeed libnl-3 is supported only. I will change to it and maybe we have also this backwards compat like iw.

I would say that really depends on how ugly this compat would be and how many people are actually need it.
For now using libnl-3 only is fine I would say.

Quoted 35 lines
Quoted 27 lines
Quoted 27 lines
website/index.txt new file +4 -0
+These tools contains:
+
+[horizontal]
+*iwpan*:: based on the wireless

http://wireless.kernel.org/en/users/Documentation/iw[iw] tool.

website/index.txt new file +4 -0
+
+Download
+~~~~~~~~
+For the last release check out

http://wpan.cakelab.org/releases/[releases] page:

website/index.txt new file +12 -0
+
+http://wpan.cakelab.org/releases/
+
+Supported Hardware
+------------------
+
+.Supported 802.15.4 Hardware
+[cols="3,4,2,^2,12",options="header"]
+|=============================================================
+|Transceiver |Supported        |Driver     | Bus |Where to buy
+|at86rf230   |no               |at86rf230? | SPI |
+|at86rf231   |yes              |at86rf230  | SPI |

http://downloads.qi-hardware.com/people/werner/wpan/web/[atben] Out of stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact
http://en.qi-hardware.com/wiki/Main_Page[qi-hardware].
+|at86rf233 |yes |at86rf230 | SPI |
http://openlabs.co/store/Raspberry-Pi-802.15.4-radio[openlabs]

Quoted 8 lines
Quoted 6 lines
+|at86rf212   |yes              |at86rf230  | SPI |
+|atusb       |not mainline yet |atusb      | USB |

http://downloads.qi-hardware.com/people/werner/wpan/web/[atusb] Out of stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact
http://en.qi-hardware.com/wiki/Main_Page[qi-hardware].
+|=============================================================

Maybe mention the other drivers we have mainline here as well? CC2520 and MRF24j40 are fully supported or not?

Quoted 7 lines

Don't know about these transceivers I have CC2520 here but these are buildin inside some contiki nodes and I don't have any pinout headers for these.

Specially MRF24j40 have some different types and I don't know which type is now supported. The driver maintainers can send patches to linux-wpan and I will apply changes to wpan-misc and generate a new website.

This sounds fair to me. People using the driver can better comment on this.

Quoted 2 lines

For futher maybe we should add some "features" collumn because many of them doesn't support all driver callbacks.

I think this is a good idea.

regards
Stefan Schmidt

maintainer
#5 lore raw

Re: [PATCH wpan-misc] website: inital commit

In reply to Alexander Aring

Hello.

website/index.txt line 117

Quoted 8 lines · Alexander Aring
website/index.txt new file +8 -0
+Rework
+~~~~~~
+
+Currently a rework of 802.15.4 subsystem is in progress.
+
+The rework will contains a new netlink API and a general handling about frame creation and parsing.
+
+.Supported 802.15.4 Hardware

Better give this table a different name. :)

website/index.txt line 128

Quoted 11 lines

+[options="header"]

+|=======================================
+|Milestone        | Description | state
+|1. nl802154      | new netlink framework              | [green]#mostly done#
+|2. crypto-layer  | accessable over nl802154 and tools | [red]#TODO#
+|3. frame parsing | remove bugs, more generical        | [red]#TODO#
+|=======================================
website/index.txt new file +4 -0
+
+For the nl802154 framework you will need the wpan-tools, older kernels need lowpan-tools but this is not recommended.
+
+// vim: set syntax=asciidoc:

regards
Stefan Schmidt

author maintainer
#6 lore raw

Re: [PATCH wpan-misc] website: inital commit

Quoted 14 lines · Stefan Schmidt

Hello.

website/index.txt line 117

Quoted 8 lines · Alexander Aring
website/index.txt new file +8 -0
+Rework
+~~~~~~
+
+Currently a rework of 802.15.4 subsystem is in progress.
+
+The rework will contains a new netlink API and a general handling about frame creation and parsing.
+
+.Supported 802.15.4 Hardware

Better give this table a different name. :)

ok, I will fix that in the next series. Thanks.

- Alex