An easy method for describing a packet
Compatible with DokuWiki
2012-10-13 Adora Belle, Weatherwax
This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.
The Packet Plugin provides an easy method for describing a packet. The plugin allows the user to specify the packet name, description, length (bytes), and format and builds the data into a standard packet description table. A packet table of contents it build above the first packet on a the page.
{{lvh_packet | | Name = Go To RGB Color Now | Description = This command causes the BlinkM to immediately change to the user specified RGB color. | Size = 4 Bytes (command byte plus three argument bytes) | Format = 0x6E RR GG BB | | SubpacketID3 = 0x6E | SubpacketSize3 = 8 | SubpacketDetails3 = Go To RGB Color Now command byte | | SubpacketID2 = R<7:0> | SubpacketSize2 = 8 | SubpacketDetails2 = Red brightness value in the range 0 to 255. A value of 0 turns red off, a value of 128 turns red on with 50% brightness and a value of 255 turns red on to maximum brightness. | | SubpacketID1 = G<7:0> | SubpacketSize1 = 8 | SubpacketDetails1 = Green brightness value in the range 0 to 255. A value of 0 turns green off, a value of 128 turns green on with 50% brightness and a value of 255 turns green on to maximum brightness. | | SubpacketID0 = B<7:0> | SubpacketSize0 = 8 | SubpacketDetails0 = Blue brightness value in the range 0 to 255. A value of 0 turns blue off, a value of 128 turns blue on with 50% brightness and a value of 255 turns blue on to maximum brightness. }}
Results in:
{{lvh_packet | | Name = | Description = | Size = | Format = | | SubpacketID3 = | SubpacketSize3 = | SubpacketDetails3 = | | SubpacketID2 = | SubpacketSize2 = | SubpacketDetails2 = | | SubpacketID1 = | SubpacketSize1 = | SubpacketDetails1 = | | SubpacketID0 = | SubpacketSize0 = | SubpacketDetails0 = }}
Note: The example above includes 4 subpackets but the plugin will accept an unlimited number of subpackets.
None
N/A