OpenCircuits - User contributions [en]

SNMP MIB Implementation

2011-05-03T18:19:59Z

Thai: /* Example SNMP PDU */

This wiki describe how to generate a MIB (Management Information Base) for SNMP agent.

==Steps==
# Create a ASN.1 MIB script '''foo.mib''' (an ASCII text file) for the tree structure.
# Convert foo.mib to binary file using '''mib2bin'''
# Build [http://www.rane.com/note161.html SNMP's PDU using BER (Base encoding rules)] encoder and decoder library to process data that's transfer between NMS and agents.
# Build SNMP API use [http://www.sics.se/~adam/uip/index.php/Main_Page uIP-stack] to communicate between NMS and Agents (open two ports: The manager speak to agents on one port, the agent responds manager on the other port).
# Build binary MIB file reader library.
# Build functions service oid tree.
# Merge MIB ANS.1 file to NMS.

==Create ASN.1 MIB Script==
* Build MIB file's written in [http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ANS.1 notation].
* Tutorial: [http://www.scribd.com/doc/276412/Understanding-SNMP-Stack Understanding SNMP Stack] to create ASN.1 MIB Script.
* Tools to create ASN.1 MIB Script
** [http://www.asnlab.com/asndt/installing.html ASN.1 Editor plugin for Eclipse] (Now using).
** [http://packages.ubuntu.com/karmic/asn1-mode Emacs mode for editing ASN.1 files].

===Abstract Syntax Notation===
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

==Convert MIB to Binary File==
* mib2bin tool is modified from [http://net-snmp.sourceforge.net/ net-snmp] to convert ASN.1 format file to three files, because the microchip '''mib2bib''' converter only supports upto 255 OIDs.
MIB compiler tools: '''mib2bin'''
[http://www.modtronix.com/products/sbc44ec/00870a.pdf foo.mib] (ANS.1 format) -----------------------------------> foo.bin + foo_trap.bin + foo.h + foo_data.h

* Syntax to use mib2bin tool:
'''mib2bin <MIBfile>...
* where MIBfile file is ASN.1 format file. MIBfile = <name>.<type>
** '''<name>.bin''' is the binary file storing information of OID tree. This file can be placed on an SD media card to be read by the FAT16 file system.
** '''<name>_trap.bin''' is the binary file storing information of TRAP of MIB. This file can be placed on an SD media card to be read by the FAT16 file system.
** '''<name>_data.h''' is C header file storing information of OID tree. This file is generated by converting mchip.bin file to the C header file.
It's only used when a system don't have system file and place on program memory.
** '''<name>.h''' is C header file storing ID that's reference to function service of OID.
* Note:
** Subfolder '''mibs''' containing the basics MIB files (e.g.: RFC1155-SMI, RFC1213-MIB, RFC-1215, SNMPv2-MIB ... for us MIB file), must be present under the directory of execution.
** If the three files exist, mib2bin tool will overwrite the files.

===Binary File Format <name>.bin===
* The binary file is an image of MIB file. It is generated by mib2bin tool. Agents will read binary file to respond NMS request.
* In the binary file, A parent is stored first, followed by its first-child to last-child. Next, the structure of next this parent is stored. This structure is repeated until the entire tree is stored.
* A parent or child is a record. Single record of binary file have format:
<oid>, <nodeInfo>,
[id], [siblingOffset]/[distantSiblingOffset], [dataType], [dataLen], [data],
[{<IndexNumber>}, {<IndexCount>, <IndexNodeInfo>, <IndexDataType>} ...]
* where:
** fields indicated by angle brackets (< >) are always present
** fields in square brackets ([ ]) are optional depending on characteristics of the current node.
** fields in braces ({ }) are optional but always occur together.

====<oid> field====
* The microchip format only supports OIDs upto 255. The following is an workaround to store OID greater than 255.
* Format of OID:
An OID is a series of (one or more) octets. Bit 8 of each octet indicates whether it is the last in the series: bit 8 of the last octet is zero;
bit 8 of each preceding octet is one. Bits 7 to 1 of the octets in the series collectively encode the OID. Conceptually, these groups of bits are
concatenated to form an unsigned binary number whose most significant bit is bit 7 of the first octet and whose least significant bit is bit 1 of
the last octet. The OID shall be encoded in the fewest possible octets, that is, the leading octet of the OID shall not have the value 0x80.

* Example:
The OID encode of OID in binary file (hex)
4 BYTE(0x04)
1 BYTE(0x01)
36061 BYTE(0x80+ 0x02) BYTE(0x80 + 0x19) BYTE(0x5D)
The OID = 36061 is decoded by 0x02*0x80*0x80 + 0x19*0x80 + 0x5D

====<nodeInfo> field====
* information of node
bit when (set = 1)
0 Node has sibling node
1 Node has default data
2 Node is sequence
3 Node is readable
4 Node is a parent
5 Node is writable
6 Node is able to modify
7 Node has sibling field (in IndexNodeInfo this bit indicate that Indexes is imply)

====[id] field====
* If this record is leaf, id that's reference to function services the record.

====[distantSiblingOffset] field====
* If this record is a node [distantSiblingOffset] is enabled. Point to next node sibling.
* In little-endian format.
* The last node's distant offset is set to 0x00000000.

====[siblingOffset] field====
* If this record is a leaf [siblingOffset] is enabled. Point to next leaf sibling.
siblingOffset and distantSiblingOffset in this format is same function (point to next node sibling).
They're only differences:
siblingOffset use with leaf node.
distantSiblingOffset use with node.
so it's same value.

====[dataType] field====
*If this record is a leaf
** [dataType] is type of leaf's data.
* The tool supports the following base data types defined in SNMPv1:
** '''INTEGER''': The integer data type is a signed integer in the range of -2,147,483,648 to 2,147,483,647.
** '''OCTETSTRING''': Octet strings are ordered sequences of 0 to 65,535 octets.
** '''Gauge''': Nonnegative integers that can increase or decrease but retain the maximum value reached. The limit of 2^32 -1.
** '''TimeTicks''': A hundredth of a second since some event. The limit of 2^32 -1.
** '''Counter''': Nonnegative integers that increase until they reach a maximum value (2^32 -1); then, the integers return to zero.
** '''DisplayString''': a special case of the octet string type where all the bytes are printable ASCII characters, include formatting characters such as CR and LF, and the C programming language string terminator character zero.
** '''IpAddress''': A four byte octet string in network order.
** '''NetworkAddress''': Used to indicate an address choice from one of the possible protocol families. Currently, only IP addresses are supported.
** '''Opaque''': An arbitrary encoding that is used to pass arbitrary information strings that do not conform to the strict data typing used by the mib.
** '''SEQUENCE''': An ordered list of objects, somewhat like a struct in the C language. Type of objects in sequence is same type of node.

====[dataLen], [data] fields====
* If this record is a leaf and has default data
** [dataLen] is length of data.
** [data] is data on string.

====[{<IndexNumber>}] and [{<IndexCount>, <IndexNodeInfo>, <IndexDataType>}] fields====
* If this record is sequence (an order list of objects),
** <IndexNumber> is the number of INDEXes in sequence.
** <IndexCount>: is id of index node in table
** <IndexNodeInfo>: is info of index node
** <IndexDataType>: is data type of index node
* See [http://www.simpleweb.org/w/images/9/91/Tutorial_Slides_Smi.pdf example] of accessing data in a table
* Example:
** '''trap''' node is a sequence to inform the NMS of a significant event (an extraordinary event has occurred at an agent) asynchronously. This sequence has two INDEXes, so we have:
<IndexNumber> = 0x02
with the 1st INDEX:
<IndexCount> = 0x05
<IndexNodeInfo> = 0x28
<IndexDataType> = 0x02
with the 2nd INDEX:
<IndexCount> = 0x08
<IndexNodeInfo> = 0xA4
<IndexDataType> = 0x04
In this example, '''trap''' is a table which has 4 columns:
trapReceiverNumber (1), trapEnabled (2), trapReceiverIPAddress (3), trapCommunity(4).
trapReceiverNumber (1), trapEnabled (2), trapReceiverIPAddress (3), trapCommunity(4).
trapReceiverNumber (1), trapEnabled (2), trapReceiverIPAddress (3), trapCommunity(4).
Each significant event will be a row defined in the '''trap''' table.

This example has two INDEXes: the 1st INDEX node is trapCommunity (4) and the 2nd INDEX node trapReceiverNumber (1)
Each INDEX is a node, so it has OID, info, data type.
The 1st INDEX node is trapCommunity, which has id = 5, info is 0x28 and data type is INTEGER (0x02). so
IndexCount = 0x04
IndexNodeInfo = 0x28
IndexDataType = 0x02
The 2nd INDEX node is trapReceiverNumber, which has id = 8, info is 0xA4 and data type is DisplayString (0x04). so
IndexCount = 0x01
IndexNodeInfo = 0xA4
IndexDataType = 0x04

===Binary File Format <name>_trap.bin===
* The binary file store TRAP information. It is generated by mib2bin tool. Agents will read binary file to get information of TRAP when something bad occurs.
* In the binary file, A enterprise OID is stored first, followed by its first specific trap number and ID (this ID is match with ID of leaf in <name>.bin) data bindings to be included in this trap to last specific trap number and ID data bindings to be included it. Next, the structure of next this enterprise is stored. This structure is repeated until all enterprise in MIB file is stored.
* The format of enterprise in <name>_trap.bin
<enterprise_oid><sibling_enterprise><enterprise_index>[specific_trap_number][sibling_specific_trap][number_varbinds][id_varbind]...
* where:
** fields indicated by angle brackets (< >) are always present.
** fields in square brackets ([ ]) are optional depending on characteristics of the trap.

====<enterprise_oid> field====
* Enterprise oid is full oid of enterprise trap that want to send in MIB file.
* The format of enterprise oid.
<sub_oid> <info_sub_oid> ...
* where:
** <sub_oid>: is same format of <oid> field in MIB file.
** <info_sub_oid>: Information of sub_oid.
<info_sub_oid> format:
bit when (set = 1)
0 the first sub_oid in enterprise
1 no use
2 no use
3 no use
4 sub_oid is a parent
5 no use
6 no use
7 the last sub_oid in enterprise
* If <sub_oid> == BYTE (0x00) and <info_sub_oid> == BYTE(0xFF), this is the end of infomation traps.

====<sibling_enterprise> field====
* Point to next enterprise OID.
* In little-endian format.
====<enterprise_index> field====
* Index of enterprise OID traps in <name>_trap.bin file.
* Size of <enterprise_index> is 1 byte.
====[specific_trap_number] field====
* If the trap is sent is specific trap, specific trap number is a number indicting specific trap.
* specific trap number is integer in little-endian format.
====[sibling_specific_trap] field====
* Point to next specific trap.
* In little-endian format.
====[number_varbinds] field====
* A number of data bindings to be included in the specific trap.
* Size of [number_varbinds] is 1 byte.
====[id_varbind] field====
* [id_varbind] define data bindings (OID and value of OID leaf) that is included specific trap.
* [id_varbind] is reference to id of the leaf oid in <name>.bin.
* In little-endian format.

===Example===

====OID Tree====
* An example OID tree is given below:
[[File:Snmp mib oid tree example.jpg | thumb | center | 900px]]

====Binary File <name>.bin====
* The corresponding binary file is <name>.bin and it has data describe in table below:
** '''oid''' is <oid> fields.
** '''info''' is <nodeInfo> fields.
** '''dist''' is [distantSiblingOffset]/[siblingOffset] fields.
** '''id''' is [id] fields.
** '''type''' is [dataType] fields.
** '''index''' is index fields of sequence, include [{index_number} , {<IndexCount>, <IndexNodeInfo>, <indexDataType>, ...}].

[[File:Snmp mib binary example.jpg | thumb | center | 900px]]

* The detail description of <name>.bin is illustrated in the diagram below:
** The black arrow lines represent the OID tree structure.
** The red and green lines represent pointers to data.
** The dist field points to next sibling record. After parent record is it's children.
[[File:Snmp mib binary detail example.jpg | thumb | center | 900px]]

====Binary File <name>_trap.bin====
* The corresponding binary file is <name>_trap.bin and it has data describe in table below:
** '''enterp''' is <enterprise_oid> fields.
** '''sibl_ep''' is <sibling_enterprise> fields.
** '''index_ep''' is <enterprise_index> fields.
** '''spec_id''' is [specific_trap_number] fields.
** '''sibl_sid''' is [sibling_specific_trap] fields.
** '''num_var''' is [number_varbinds] fields.
** '''id_var''' is [id_varbind] fields.
[[File:Snmp mib binary trap example.jpg | thumb | center | 900px]]

==[http://www.rane.com/note161.html=Build SNMP's PDU using BER]==
* SNMP is the protocol that allows communicate between NMS and agents by exchanging SNMP messages. the SNMP message is a single field, of the Sequence type. SNMP message use data types specified by ASN.1 and use Basic Encoding Rules (BER) to encode data. The entire SNMP message is a Sequence of three smaller fields: the SNMP Version (Integer), the SNMP Community String (Octet String), and the SNMP PDU.
* The SNMP's PDU is reference to SNMP version 1 (SNMPv1) PDU.
* SNMPv1 PDU have five different PDU types:GetRequest, GetNextRequest, GetResponse, SetRequest and Trap.
* Get Request, GetNext Request, Get Response, Set Request are same format PDU. Trap use other format PDU.
===ASN.1 data types===
* ASN.1 data types fall into two categories: primitive and complex.
* ASN.1 data types is used to build SNMP messages.
** ASN.1 primitive data types include Integer, Octet (byte, character) String, Null, Boolean and Object Identifier.
** ASN.1 complex data types are used to build SNMP message are Sequence type, Sequence-of type.

===[http://www.google.com/url?sa=t&source=web&cd=1&ved=0CBgQFjAA&url=http%3A%2F%2Fwww.itu.int%2FITU-T%2Fstudygroups%2Fcom17%2Flanguages%2FX.690-0207.pdf&rct=j&q=x.690-0207&ei=cde_TcrvJouMvQOm5-jABA&usg=AFQjCNGYmD4USBwcWoeHoRFZ3zdP39kosw&cad=rja=Basic Encoding Rules (BER)]===
* BER has three parts: Type, Length and Data field.
BER format:
+------+--------+------+
| Type | Length | Data |
+------+--------+------+

* Type field is single byte identifier.
'''Constructing byte Data type.'''
Format of byte Data type
+--+-+-----+
| | | +
+--+-+-----+
2 1 5
Bits 8 and 7 shall be encoded to represent the class of Data type follow table:
+------------------+-------+-------+
| Class | Bit 8 | Bit 7 |
+------------------+-------+-------+
| Universal | 0 | 0 |
| Application | 0 | 1 |
| Context-specific | 1 | 0 |
| Private | 1 | 1 |
+------------------+-------+-------+
Bit 6 is encoded data is Primitive or Constructed follow table:
+-------+-------------+
| Bit 6 | Type |
+-------+-------------+
| 0 | Primitive |
| 1 | Constructed |
+-------+-------------+
Bits 5 to 1 encode the number of Data type as a integer number.

'''Data type identifier in SNMP'''
'''Data type''' '''Identifier''' '''Note'''
Integer 0x02 Primitive ASN.1 types
Octet String 0x04 Primitive ASN.1 types
Null 0x05 Primitive ASN.1 types
Object identifier 0x06 Primitive ASN.1 types
Sequence 0x30 Constructed ASN.1 types
IpAddress 0x40 Primitive SNMP application types
Counter 0x41 Primitive SNMP application types
Gauge 0x42 Primitive SNMP application types
TimeTicks 0x43 Primitive SNMP application types
Opaque 0x44 Primitive SNMP application types
NsapAddress 0x45 Primitive SNMP application types
GetRequest PDU 0xA0 Context-specific Constructed SNMP types
GetNextRequest PDU 0xA1 Context-specific Constructed SNMP types
GetResponse PDU 0xA2 Context-specific Constructed SNMP types
SetRequest PDU 0xA3 Context-specific Constructed SNMP types
Trap PDU 0xA4 Context-specific Constructed SNMP types
* Length field is the number of bytes in Data field.
** Length field is used either the short form or the long form as a option depend on Data field.
*** The short form, Length field is a single octet in which bit 8 is zero and bits 7 to 1 encode the number of bytes in Data field, as an unsigned binary integer with bit 7 as the most significant bit.
*** The long form, Length field shall consists of an initial octet and one or more subsequent octets.
**** The initial octet is encoded as follows:
***** Bit 8 shall be one.
***** Bits 7 to 1 shall encode the number of subsequent octets in the length field, as an unsigned binary integer with bit 7 as the most significant bit.
***** The value 0xFF shall not be used.
**** Subsequent octets:
***** From the first subsequent octet to the last subsequent octet, shall be the encoding of an unsigned binary integer equal to the number bytes in Data field, with bit 8 of the first subsequent octet as the most significant bit.
* Data field is actual data content.

* Example:
Actual Data is an integer, the value 100 can be encode as:
The short form:
+------+--------+-------+
| Type | Length | Data |
+------+--------+-------+
| 0x02 | 0x01 | 0x64 |
+------+--------+-------+
The long form:
+------+-----------+-------+
| Type | Length | Data |
+------+-----------+-------+
| 0x02 | 0x81 0x01 | 0x64 |
+------+-----------+-------+
===SNMP Message Format===
* SNMP Message is a Sequence of three smaller fields: the SNMP Version (Integer), the SNMP Community String (Octet String), and the SNMP PDU.
SNMP Message Format use BER.
+------------------------------------------------------------------------+
| SNMP Message (Sequence type) |
+------+----------------+------------------------------------------------+
| Type | Length of Data | Data |
+------+----------------+-------------+-----------------------+----------+
| 0x30 | Length |SNMP Version | SNMP Community String | SNMP PDU |
| | | (Integer) | (Octet String) | |
+------+----------------+-------------+-----------------------+----------+
|<--------------------Length-------------------->|
* Length is bytes of Data field (SNMP Version, SNMP Community String and SNMP PDU).
* SNMP Version is an integer that identifies the version of SNMP, SNMP version 1 = 0.
* SNMP Community String is an Octet String to add security to Agents.
* SNMP PDU is a SNMP verion 1 (SNMPv1) PDU.

===SNMP PDU Format===
* SNMP PDU is is reference to SNMP version 1 (SNMPv1) PDU.
====GetRequest PDU, GetNextRequest PDU, GetResponse PDU, SetRequest PDU Format====
* GetRequest PDU, GetNextRequest PDU, GetResponse PDU, SetRequest PDU Format is shown here.
+-------------------------------------------------------------------------------------------------------------------------------------+
| SNMPv1 PDU (GetRequest, GetNextRequest, GetResponse, SetRequest |
+------+--------+---------------------------------------------------------------------------------------------------------------------+
| PDU | Length | Data of SNMP PDU |
| type | Data | |
+------+--------+---------+---------+---------+---------------------------------------------------------------------------------------+
| PDU | Length | Request | Error | Error | VarBind List (Sequence) |
| type | PDU | ID | Status | Index +------+--------+--------------------------------+--------------------------------+-----+
| | | | | | 0x30 | Length | Varbind 1 | Varbind 2 | ... |
| | |(Integer)|(Integer)|(Integer)| | | (Sequence) | (Sequence) | ... |
| | | | | | | +------+-------+-------+---------+------+-------+-------+---------+-----+
| | | | | | | | 0x30 | Len 1 | OID 1 | Value 1 | 0x30 | Len 2 | OID 1 | Value 2 | ... |
+------+--------+---------+---------+---------+------+--------+------+-------+-------+---------+------+-------+-------+---------+-----+
| | |<-----Len 1----->| |<-----Len 2----->| |
| |<-------------------------------Length-------------------------------->|
|<----------------------------------------------Lenght PDU----------------------------------------------------------->|
* PDU Type is specific type of PDU, PDU Type is a single byte identifier.
* Length Data is a number bytes of Data of SNMP PDU field.
* Data of SNMP PDU is data content in SNMP PDU.
* Request ID is an Integer that identifies a particular SNMP request. This index is echoed back in the response from the SNMP agent, allowing the SNMP manager to match an incoming response to the appropriate request.
* Error Status is an Integer set to 0x00 in the request sent by the NMS. The SNMP agent places an error code in this field in the response message if an error occurred processing the request.
Some error codes include:
+-------------------+---------------------------------------------------------------------------+
| Error Status | |
+------------+------+ Description |
| Name | Code | |
+------------+------+---------------------------------------------------------------------------+
| noError | 0x00 | No error occurred. |
| tooBig | 0x01 | The response to your request was too big to fit into one response. |
| noSuchName | 0x02 | The OID in the request was not found.the OID doesn't exist. |
| badValue | 0x03 | A data type in the request did not match the data type in the SNMP agent. |
| readOnly | 0x04 | The SNMP manager attempted to set a read-only parameter. |
| genErr | 0x05 | General Error (some error other than the ones listed above). |
+------------+------+---------------------------------------------------------------------------+
* Error Index is an Integer. Only the response operation sets this field, if an Error occurs, the Error Index holds a pointer to the Object that caused the error. Other operations set this field to zero.
* Varbind List is a Sequence of Varbinds.
** Varbind is a Sequence of two fields, an OID and the value of OID.
*** OID is an Object Identifier that points to a particular parameter in the SNMP agent.
*** Value is the value of OID.
+--------------------+-----------------------------------------------------------------+
| SNMP PDU type | Value |
+--------------------+-----------------------------------------------------------------+
| SetRequest PDU | Value is applied to the specified OID of the SNMP agent. |
| GetRequest PDU | Value is a Null that acts as a placeholder for the return data. |
| GetNextRequest PDU | Value is a Null that acts as a placeholder for the return data. |
| GetResponse PDU | The returned Value from the specified OID of the SNMP agent. |
+--------------------+-----------------------------------------------------------------+
====[http://docstore.mik.ua/orelly/networking_2ndEd/snmp/ch10_03.htm= Trap PDU Format]====
* The format of the Trap PDU is shown below:
+------------------------------------------------------------------------------------------------------------------------------------------+
| TRAP SNMPv1 PDU |
+----+------+------------------------------------------------------------------------------------------------------------------------------+
|PDU |Length| Data of SNMP PDU |
|type| Data | |
+----+------+----------+-------+-------+--------+------+---------------------------------------------------- ------------------------------+
|0xA4|Length|Enterprise| Agent |Generic|Specific|Time | VarBind List (Sequence) |
| | PDU | OID |Address| Trap | Trap |Stamp +------+--------+------------------------------+------------------------------+-----+
| | | | | Type | Number | | 0x30 | Length | Varbind 1 | Varbind 22 | ... |
| | | (OID) | | | | | | | (Sequence) | (Sequence) | ... |
| | | | | | | | | +----+-------+-------+---------+----+-------+-------+---------+-----+
| | | | | | | | | |0x30| Len 1 | OID 1 | Value 1 |0x30| Len 2 | OID 1 | Value 2 | ... |
+----+------+----------+-------+-------+--------+------+------+--------+----+-------+-------+---------+----+-------+-------+---------+-----+
| | |<-----Len 1----->| |<-----Len 2----->| |
| |<-----------------------------Length------------------------------>|
|<--------------------------------------------Lenght PDU----------------------------------------------------------->|
* PDU type is TRAP PDU = 0xA4.
* Length Data is a number bytes of Data of SNMP PDU field.
* Enterprise OID identifies the type of managed object generating the trap.
* Agent Address is the IP address of the agent that is sending the trap.
* [http://docstore.mik.ua/orelly/networking_2ndEd/snmp/ch02_06.htm#enettdg-CHP-2-TABLE-8= Generic Trap Type] indicates one of a number of generic trap types.
Generic Trap Type has seven values are defined:
+------------------------------+---------------------------------------------------------------------------+
| Generic Trap Type | |
+-----------------------+------+ Description |
| Name | Code | |
+-----------------------+------+---------------------------------------------------------------------------+
| coldStart | 0x00 | Indicates that the agent has rebooted. All management variables will be |
| | | reset; specifically, Counters and Gauges will be reset to zero (0). |
+-----------------------+------+---------------------------------------------------------------------------+
| warmStart | 0x01 | Indicates that the agent has reinitialized itself. None of the management |
| | | variables will be reset. |
+-----------------------+------+---------------------------------------------------------------------------+
| linkDown | 0x02 | Sent when an interface on a device goes down. The first variable binding |
| | | identifies which interface went down. |
+-----------------------+------+---------------------------------------------------------------------------+
| linkUp | 0x03 | Sent when an interface on a device comes back up. The first variable |
| | | binding identifies which interface came back up. |
+-----------------------+------+---------------------------------------------------------------------------+
| authenticationFailure | 0x04 | Indicates that someone has tried to query your agent with an incorrect |
| | | community string; useful in determining if someone is trying to gain |
| | | unauthorized access to one of your devices. |
+-----------------------+------+---------------------------------------------------------------------------+
| egpNeighborLoss | 0x05 | Indicates that an Exterior Gateway Protocol (EGP) neighbor has gone down. |
+-----------------------+------+---------------------------------------------------------------------------+
| enterpriseSpecific | 0x06 | Indicates that the trap is enterprise-specific. SNMP vendors and users |
| | | define their own traps under the private-enterprise branch of the SMI |
| | | object tree. To process this trap properly, the NMS has to decode the |
| | | specific trap number that is part of the SNMP message. |
+-----------------------+------+---------------------------------------------------------------------------+
* Specific trap number is a number indicating the specific trap you want to send. If you're sending a generic trap, this parameter is ignored -- you're probably better off setting it to zero.
* Time stamp is the time elapsed between the last initialization of the network entity and the generation of the trap.
* Varbind List is a Sequence of Varbinds to be included in the trap.
** Varbind is a Sequence of two fields, an OID and the value of OID.
*** OID is an Object Identifier that points to a particular parameter in the SNMP agent.
*** Value is the value of OID
===Example SNMP Message===
====GetRequest PDU====
* The example gets the value of name agent with above MIB file.
* Community String is "public"
+---------+-----------+------------------------------------------------------------------------------------------------------+
| SNMP | Type | 0x30 |
| message +-----------+------------------------------------------------------------------------------------------------------+
| |Length | 0x2B |
| +-----------+------------------------------------------------------------------------------------------------------+
| | Version | 0x02 |
| | | 0x01 |
| | | 0x00 |
| +-----------+------------------------------------------------------------------------------------------------------+
| | Community | 0x04 |
| | | 0x06 |
| | | 0x70 0x75 0x62 0x6C 0x69 0x63 |
| +-----------+ -------+--------------+------------------------------------------------------------------------------+
| | Data | SNMPv1 | PDU type | 0xA0 |
| | | PDU +--------------+------------------------------------------------------------------------------+
| | | | PDU length | 0x1E |
| | | + -------------+------------------------------------------------------------------------------+
| | | | Request ID | 0x02 |
| | | | | 0x04 |
| | | | | 0x37 0x9C 0x57 0x89 |
| | | + -------------+------------------------------------------------------------------------------+
| | | | Error Status | 0x02 |
| | | | | 0x01 |
| | | | | 0x00 |
| | | + -------------+------------------------------------------------------------------------------+
| | | | Error Index | 0x02 |
| | | | | 0x01 |
| | | | | 0x00 |
| | | + -------------+------------------------------------------------------------------------------+
| | | | VarBind List | 0x30 |
| | | | +-----------+------------------------------------------------------------------+
| | | | | Length | 0x10 |
| | | | +-----------+------------------------------------------------------------------+
| | | | | VarBind 1 | 0x30 |
| | | | | +---------+--------------------------------------------------------+
| | | | | | Len 1 | 0x0E |
| | | | | +---------+--------------------------------------------------------+
| | | | | | OID 1 | 0x06 |
| | | | | | | 0x0A |
| | | | | | | 0x2B 0x06 0x01 0x04 0x01 0x82 0x99 0x5D 0x02 |
| | | | | +---------+--------------------------------------------------------+
| | | | | | Value 1 | 0x05 |
| | | | | | | 0x00 |
+---------+-----------+--------+--------------+-----------+---------+--------------------------------------------------------+

SNMP MIB Implementation

2011-05-03T17:35:07Z

Thai: /* SNMP's PDU using BER */

SNMP MIB Implementation

2011-05-03T17:22:58Z

Thai: /* SNMP PDU Format */

==[http://www.rane.com/note161.html=Build SNMP's PDU using BER]==
* SNMP is the protocol that allows communicate between NMS and agents by exchanging SNMP messages. the SNMP message is a single field, of the Sequence type. SNMP message use data types specified by ASN.1 and use Basic Encoding Rules (BER) to encode data. The entire SNMP message is a Sequence of three smaller fields: the SNMP Version (Integer), the SNMP Community String (Octet String), and the SNMP PDU.
* The SNMP's PDU is reference to SNMP version 1 (SNMPv1) PDU.
* SNMPv1 PDU have five different PDU types:GetRequest, GetNextRequest, GetResponse, SetRequest and Trap.
* Get Request, GetNext Request, Get Response, Set Request are same format PDU. Trap use other format PDU.
===ASN.1 data types===
* ASN.1 data types fall into two categories: primitive and complex.
* ASN.1 data types is used to build SNMP messages.
** ASN.1 primitive data types include Integer, Octet (byte, character) String, Null, Boolean and Object Identifier.
** ASN.1 complex data types are used to build SNMP message are Sequence type, Sequence-of type.

===[http://www.google.com/url?sa=t&source=web&cd=1&ved=0CBgQFjAA&url=http%3A%2F%2Fwww.itu.int%2FITU-T%2Fstudygroups%2Fcom17%2Flanguages%2FX.690-0207.pdf&rct=j&q=x.690-0207&ei=cde_TcrvJouMvQOm5-jABA&usg=AFQjCNGYmD4USBwcWoeHoRFZ3zdP39kosw&cad=rja=Basic Encoding Rules (BER)]===
* BER has three parts: Type, Length and Data field.
BER format:
+------+--------+------+
| Type | Length | Data |
+------+--------+------+

* Type field is single byte identifier.
'''Constructing byte Data type.'''
Format of byte Data type
+--+-+-----+
| | | +
+--+-+-----+
2 1 5
Bits 8 and 7 shall be encoded to represent the class of Data type follow table:
+------------------+-------+-------+
| Class | Bit 8 | Bit 7 |
+------------------+-------+-------+
| Universal | 0 | 0 |
| Application | 0 | 1 |
| Context-specific | 1 | 0 |
| Private | 1 | 1 |
+------------------+-------+-------+
Bit 6 is encoded data is Primitive or Constructed follow table:
+-------+-------------+
| Bit 6 | Type |
+-------+-------------+
| 0 | Primitive |
| 1 | Constructed |
+-------+-------------+
Bits 5 to 1 encode the number of Data type as a integer number.

'''Data type identifier in SNMP'''
'''Data type''' '''Identifier''' '''Note'''
Integer 0x02 Primitive ASN.1 types
Octet String 0x04 Primitive ASN.1 types
Null 0x05 Primitive ASN.1 types
Object identifier 0x06 Primitive ASN.1 types
Sequence 0x30 Constructed ASN.1 types
IpAddress 0x40 Primitive SNMP application types
Counter 0x41 Primitive SNMP application types
Gauge 0x42 Primitive SNMP application types
TimeTicks 0x43 Primitive SNMP application types
Opaque 0x44 Primitive SNMP application types
NsapAddress 0x45 Primitive SNMP application types
GetRequest PDU 0xA0 Context-specific Constructed SNMP types
GetNextRequest PDU 0xA1 Context-specific Constructed SNMP types
GetResponse PDU 0xA2 Context-specific Constructed SNMP types
SetRequest PDU 0xA3 Context-specific Constructed SNMP types
Trap PDU 0xA4 Context-specific Constructed SNMP types
* Length field is the number of bytes in Data field.
** Length field is used either the short form or the long form as a option depend on Data field.
*** The short form, Length field is a single octet in which bit 8 is zero and bits 7 to 1 encode the number of bytes in Data field, as an unsigned binary integer with bit 7 as the most significant bit.
*** The long form, Length field shall consists of an initial octet and one or more subsequent octets.
**** The initial octet is encoded as follows:
***** Bit 8 shall be one.
***** Bits 7 to 1 shall encode the number of subsequent octets in the length field, as an unsigned binary integer with bit 7 as the most significant bit.
***** The value 0xFF shall not be used.
**** Subsequent octets:
***** From the first subsequent octet to the last subsequent octet, shall be the encoding of an unsigned binary integer equal to the number bytes in Data field, with bit 8 of the first subsequent octet as the most significant bit.
* Data field is actual data content.

* Example:
Actual Data is an integer, the value 100 can be encode as:
The short form:
+------+--------+-------+
| Type | Length | Data |
+------+--------+-------+
| 0x02 | 0x01 | 0x64 |
+------+--------+-------+
The long form:
+------+-----------+-------+
| Type | Length | Data |
+------+-----------+-------+
| 0x02 | 0x81 0x01 | 0x64 |
+------+-----------+-------+
===SNMP Message Format===
* SNMP Message is a Sequence of three smaller fields: the SNMP Version (Integer), the SNMP Community String (Octet String), and the SNMP PDU.
SNMP Message Format use BER.
+------------------------------------------------------------------------+
| SNMP Message (Sequence type) |
+------+----------------+------------------------------------------------+
| Type | Length of Data | Data |
+------+----------------+-------------+-----------------------+----------+
| 0x30 | Length |SNMP Version | SNMP Community String | SNMP PDU |
| | | (Integer) | (Octet String) | |
+------+----------------+-------------+-----------------------+----------+
|<--------------------Length-------------------->|
* Length is bytes of Data field (SNMP Version, SNMP Community String and SNMP PDU).
* SNMP Version is an integer that identifies the version of SNMP, SNMP version 1 = 0.
* SNMP Community String is an Octet String to add security to Agents.
* SNMP PDU is a SNMP verion 1 (SNMPv1) PDU.

===SNMP PDU Format===
* SNMP PDU is is reference to SNMP version 1 (SNMPv1) PDU.
====GetRequest PDU, GetNextRequest PDU, GetResponse PDU, SetRequest PDU Format====
* GetRequest PDU, GetNextRequest PDU, GetResponse PDU, SetRequest PDU Format is shown here.
+-------------------------------------------------------------------------------------------------------------------------------------+
| SNMPv1 PDU (GetRequest, GetNextRequest, GetResponse, SetRequest |
+------+--------+---------------------------------------------------------------------------------------------------------------------+
| PDU | Length | Data of SNMP PDU |
| type | Data | |
+------+--------+---------+---------+---------+---------------------------------------------------------------------------------------+
| PDU | Length | Request | Error | Error | VarBind List (Sequence) |
| type | PDU | ID | Status | Index +------+--------+--------------------------------+--------------------------------+-----+
| | | | | | 0x30 | Length | Varbind 1 | Varbind 2 | ... |
| | |(Integer)|(Integer)|(Integer)| | | (Sequence) | (Sequence) | ... |
| | | | | | | +------+-------+-------+---------+------+-------+-------+---------+-----+
| | | | | | | | 0x30 | Len 1 | OID 1 | Value 1 | 0x30 | Len 2 | OID 1 | Value 2 | ... |
+------+--------+---------+---------+---------+------+--------+------+-------+-------+---------+------+-------+-------+---------+-----+
| | |<-----Len 1----->| |<-----Len 2----->| |
| |<-------------------------------Length-------------------------------->|
|<----------------------------------------------Lenght PDU----------------------------------------------------------->|
* PDU Type is specific type of PDU, PDU Type is a single byte identifier.
* Length Data is a number bytes of Data of SNMP PDU field.
* Data of SNMP PDU is data content in SNMP PDU.
* Request ID is an Integer that identifies a particular SNMP request. This index is echoed back in the response from the SNMP agent, allowing the SNMP manager to match an incoming response to the appropriate request.
* Error Status is an Integer set to 0x00 in the request sent by the NMS. The SNMP agent places an error code in this field in the response message if an error occurred processing the request.
Some error codes include:
+-------------------+---------------------------------------------------------------------------+
| Error Status | |
+------------+------+ Description |
| Name | Code | |
+------------+------+---------------------------------------------------------------------------+
| noError | 0x00 | No error occurred. |
| tooBig | 0x01 | The response to your request was too big to fit into one response. |
| noSuchName | 0x02 | The OID in the request was not found.the OID doesn't exist. |
| badValue | 0x03 | A data type in the request did not match the data type in the SNMP agent. |
| readOnly | 0x04 | The SNMP manager attempted to set a read-only parameter. |
| genErr | 0x05 | General Error (some error other than the ones listed above). |
+------------+------+---------------------------------------------------------------------------+
* Error Index is an Integer. Only the response operation sets this field, if an Error occurs, the Error Index holds a pointer to the Object that caused the error. Other operations set this field to zero.
* Varbind List is a Sequence of Varbinds.
** Varbind is a Sequence of two fields, an OID and the value of OID.
*** OID is an Object Identifier that points to a particular parameter in the SNMP agent.
*** Value is the value of OID.
+--------------------+-----------------------------------------------------------------+
| SNMP PDU type | Value |
+--------------------+-----------------------------------------------------------------+
| SetRequest PDU | Value is applied to the specified OID of the SNMP agent. |
| GetRequest PDU | Value is a Null that acts as a placeholder for the return data. |
| GetNextRequest PDU | Value is a Null that acts as a placeholder for the return data. |
| GetResponse PDU | The returned Value from the specified OID of the SNMP agent. |
+--------------------+-----------------------------------------------------------------+
====[http://docstore.mik.ua/orelly/networking_2ndEd/snmp/ch10_03.htm= Trap PDU Format]====
* The format of the Trap PDU is shown below:
+------------------------------------------------------------------------------------------------------------------------------------------+
| TRAP SNMPv1 PDU |
+----+------+------------------------------------------------------------------------------------------------------------------------------+
|PDU |Length| Data of SNMP PDU |
|type| Data | |
+----+------+----------+-------+-------+--------+------+---------------------------------------------------- ------------------------------+
|0xA4|Length|Enterprise| Agent |Generic|Specific|Time | VarBind List (Sequence) |
| | PDU | OID |Address| Trap | Trap |Stamp +------+--------+------------------------------+------------------------------+-----+
| | | | | Type | Number | | 0x30 | Length | Varbind 1 | Varbind 22 | ... |
| | | (OID) | | | | | | | (Sequence) | (Sequence) | ... |
| | | | | | | | | +----+-------+-------+---------+----+-------+-------+---------+-----+
| | | | | | | | | |0x30| Len 1 | OID 1 | Value 1 |0x30| Len 2 | OID 1 | Value 2 | ... |
+----+------+----------+-------+-------+--------+------+------+--------+----+-------+-------+---------+----+-------+-------+---------+-----+
| | |<-----Len 1----->| |<-----Len 2----->| |
| |<-----------------------------Length------------------------------>|
|<--------------------------------------------Lenght PDU----------------------------------------------------------->|
* PDU type is TRAP PDU = 0xA4.
* Length Data is a number bytes of Data of SNMP PDU field.
* Enterprise OID identifies the type of managed object generating the trap.
* Agent Address is the IP address of the agent that is sending the trap.
* [http://docstore.mik.ua/orelly/networking_2ndEd/snmp/ch02_06.htm#enettdg-CHP-2-TABLE-8= Generic Trap Type] indicates one of a number of generic trap types.
Generic Trap Type has seven values are defined:
+------------------------------+---------------------------------------------------------------------------+
| Generic Trap Type | |
+-----------------------+------+ Description |
| Name | Code | |
+-----------------------+------+---------------------------------------------------------------------------+
| coldStart | 0x00 | Indicates that the agent has rebooted. All management variables will be |
| | | reset; specifically, Counters and Gauges will be reset to zero (0). |
+-----------------------+------+---------------------------------------------------------------------------+
| warmStart | 0x01 | Indicates that the agent has reinitialized itself. None of the management |
| | | variables will be reset. |
+-----------------------+------+---------------------------------------------------------------------------+
| linkDown | 0x02 | Sent when an interface on a device goes down. The first variable binding |
| | | identifies which interface went down. |
+-----------------------+------+---------------------------------------------------------------------------+
| linkUp | 0x03 | Sent when an interface on a device comes back up. The first variable |
| | | binding identifies which interface came back up. |
+-----------------------+------+---------------------------------------------------------------------------+
| authenticationFailure | 0x04 | Indicates that someone has tried to query your agent with an incorrect |
| | | community string; useful in determining if someone is trying to gain |
| | | unauthorized access to one of your devices. |
+-----------------------+------+---------------------------------------------------------------------------+
| egpNeighborLoss | 0x05 | Indicates that an Exterior Gateway Protocol (EGP) neighbor has gone down. |
+-----------------------+------+---------------------------------------------------------------------------+
| enterpriseSpecific | 0x06 | Indicates that the trap is enterprise-specific. SNMP vendors and users |
| | | define their own traps under the private-enterprise branch of the SMI |
| | | object tree. To process this trap properly, the NMS has to decode the |
| | | specific trap number that is part of the SNMP message. |
+-----------------------+------+---------------------------------------------------------------------------+
* Specific trap number is a number indicating the specific trap you want to send. If you're sending a generic trap, this parameter is ignored -- you're probably better off setting it to zero.
* Time stamp is the time elapsed between the last initialization of the network entity and the generation of the trap.
* Varbind List is a Sequence of Varbinds to be included in the trap.
** Varbind is a Sequence of two fields, an OID and the value of OID.
*** OID is an Object Identifier that points to a particular parameter in the SNMP agent.
*** Value is the value of OID

SNMP MIB Implementation

2011-05-03T16:28:40Z

Thai: /* SNMPv1 PDU Format */

SNMP MIB Implementation

2011-05-03T15:31:12Z

Thai: /* SNMP Message Format */

SNMP MIB Implementation

2011-05-03T15:20:24Z

Thai: /* SNMP Message Format */

SNMP MIB Implementation

2011-05-03T15:09:29Z

Thai: /* SNMP Message Format */

SNMP MIB Implementation

2011-05-03T15:08:44Z

Thai: /* Build SNMP's PDU using BER */

File:Snmp mib binary trap example.jpg

2011-05-03T06:49:08Z

Thai: uploaded a new version of "File:Snmp mib binary trap example.jpg"

File:Snmp mib binary detail example.jpg

2011-05-03T06:44:37Z

Thai: uploaded a new version of "File:Snmp mib binary detail example.jpg"

File:Snmp mib binary example.jpg

2011-05-03T06:43:14Z

Thai: uploaded a new version of "File:Snmp mib binary example.jpg"

SNMP MIB Implementation

2011-05-02T17:40:38Z

Thai: /* Binary File .bin */

File:Snmp mib binary trap example.jpg

2011-05-02T17:38:54Z

Thai:

SNMP MIB Implementation

2011-05-02T17:38:27Z

Thai: /* field */

SNMP MIB Implementation

2011-05-02T17:35:17Z

Thai: /* Binary File Format .bin */

SNMP MIB Implementation

2011-05-02T17:33:52Z

Thai: /* Binary File .bin */

SNMP MIB Implementation

2011-05-02T17:25:35Z

Thai: /* [dataType], [dataLen], [data] fields */

File:Snmp mib binary example.jpg

2011-05-02T16:55:19Z

Thai: uploaded a new version of "File:Snmp mib binary example.jpg"

File:Snmp mib oid tree example.jpg

2011-04-28T17:34:36Z

Thai: uploaded a new version of "File:Snmp mib oid tree example.jpg"

SNMP MIB Implementation

2011-04-27T17:44:12Z

Thai: /* Convert MIB to Binary File */

SNMP MIB Implementation

2011-04-27T17:41:44Z

Thai: /* Convert MIB to Binary File */

SNMP MIB Implementation

2011-04-27T17:40:48Z

Thai: /* Convert MIB to Binary File */

File:Snmp mib binary detail example.jpg

2010-10-05T17:24:59Z

Thai: uploaded a new version of "File:Snmp mib binary detail example.jpg": change integer in little-endian format.

File:Snmp mib binary example.jpg

2010-10-05T17:24:06Z

Thai: uploaded a new version of "File:Snmp mib binary example.jpg": change integer in little-endian format.

File:Snmp mib binary detail example.jpg

2010-10-02T15:12:08Z

Thai: uploaded a new version of "File:Snmp mib binary detail example.jpg": The last node's distant offset is set to 0x00000000

File:Snmp mib binary example.jpg

2010-10-02T15:10:33Z

Thai: uploaded a new version of "File:Snmp mib binary example.jpg": The last node's distant offset is set to 0x00000000

SNMP MIB Implementation

2010-10-02T14:53:42Z

Thai: /* Create ASN.1 MIB Script */

SNMP MIB Implementation

2010-09-30T17:40:21Z

Thai: /* [{}] */

SNMP MIB Implementation

2010-09-30T17:03:31Z

Thai: /* [dataType], [dataLen], [data] fields */

SNMP MIB Implementation

2010-09-30T16:42:19Z

Thai: /* [siblingOffset] field */

SNMP MIB Implementation

2010-09-30T15:56:54Z

Thai: /* [distantSiblingOffset] field */

SNMP MIB Implementation

2010-09-28T17:38:02Z

Thai: /* Example */

This wiki describe how to generate a MIB (Management Information Base) for SNMP agent.

==Steps==
# Create a Microchip Custom MIB script '''snmp.mib''' (an ASCII text file) for the tree structure.
# Create a ASN.1 MIB script '''foo.mib''' (an ASCII text file) for the tree structure.
# Convert foo.mib to binary file using '''mib2bin'''
# Build [http://www.rane.com/note161.html snmp's PDU use BER (Base encoding rules)] encoder and decoder library to process data that's transfer between NMS and agents.
# Build snmp API use [http://www.sics.se/~adam/uip/index.php/Main_Page uIP-stack] to communicate between NMS and Agents (open two ports: The manager speak to agents on one port, the agent responds manager on the other port).
# Build binary MIB file reader library.
# Build functions service oid tree.
# Merge MIB ANS.1 file to NMS.

==Create Microchip Custom MIB Script==
* Is this file needed?
don't needed creat Microchip MIB script.
* If so any tutorial to create this file?

==Create ASN.1 MIB Script==
* Build MIB file's written in [http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ANS.1 notation].
* Any tutorial to create this file?

===Abstract Syntax Notation===
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

==Convert MIB to Binary File==
* mib2bin tool is modified from [http://net-snmp.sourceforge.net/ net-snmp] to convert ASN.1 format file to three files, because the microchip '''mib2bib''' converter only supports upto 255 OIDs.
MIB compiler tools: '''mib2bin'''
[http://www.modtronix.com/products/sbc44ec/00870a.pdf foo.mib] (ANS.1 format) -----------------------------------> foo.bin + foo.h + foo_data.h

* Syntax to use mib2bin tool:
'''mib2bin <MIBfile>...
* where MIBfile file is ASN.1 format file. MIBfile = <name>.<type>
** '''<name>.bin''' is the binary file storing information of OID tree. This file can be placed on an SD media card to be read by the FAT16 file system.
** '''<name>_data.h''' is C header file storing information of OID tree. This file is generated by converting mchip.bin file to the C header file. It's only used when a system don't have system file and place on program memory.
** '''<name>.h''' is C header file storing ID that's reference to function service of OID.
* Note:
** Subfolder '''mibs''' containing the basics MIB files (e.g.: RFC1155-SMI, RFC1213-MIB, RFC-1215, SNMPv2-MIB ... for us MIB file), must be present under the directory of execution.
** If the three files exist, mib2bin tool will overwrite the files.

===Binary File Format===
* The binary file is an image of MIB file. It is generated by mib2bin tool. Agents will read binary file to respond NMS request.
* In the binary file, A parent is stored first, followed by its last-child to first-child. Next, the structure of next this parent is stored. This structure is repeated until the entire tree is stored.
* A parent or child is a record. Single record of binary file have format:
<oid>, <nodeInfo>,
[id], [siblingOffset], [distantSiblingOffset], [dataType], [dataLen], [data],
[{<index_number>},{<IndexCount>, <IndexNodeInfo>, <indexDataType>} ...]

where:
fields indicated by angle brackets (< >) are always present
fields in square brackets ([ ]) are optional depending on characteristics of the current node.
fields in braces ({}) are optional but always occur together.

====<oid> field====
* Format of OID:
oid1 char(16)
oid2 char(16)
....
* if oid_i < 254: oid_i = char (oid_i)
* else oid_i = char(255) + char(length of oid_i) + oid_i (base 255) + char(16)
* If this a standard representation, or is a workaround of the microchip format?
This is an workaround to store oids, but this isn't a standard representation or the microchip format.
* What does char(.) mean?
char(x) that's mean get ascii of x.
char(16) is used to separate two oids.
char(255) is determined that oid geater than 254.
"length of oid_i" is length string of oid_i that's converted base 255.

====<nodeInfo> field====
* information of node
bit when (set = 1)
0 Node is a parent (0: node is a leaf)
1 Node is sequence
2 Node is readable
3 Node is writable
4 Node is able to create
5 Node has default data
6 (if node is sequence, this is mean implied index node)
7 always set 1

====[id] field====
* If this record is leaf, id that's reference to function services the record.
* leaf means child?
leaf means child, but child doesn't mean leaf.
the comment fixed.

====[distantSiblingOffset] field====
* If this record is a node [distantSiblingOffset] is enabled. Point to next node sibling.
* root node should have no sibling. How come the example (below) has a distant offset BC000000? Also, is it big-endian or little-endian?

====[siblingOffset] field====
* If this record is a leaf [siblingOffset] is enabled. Point to next leaf sibling.
* I can see some child nodes in the example, but the table does not have any siblingOffset, can you explain?

====[dataType], [dataLen], [data] fields====
* If this record is a leaf and has default data
** [dataType] is type of leaf's data.
** [dataLen] is length of data.
** [data] is data on string.
* How many dataType does it support?

====[{<index_number>}]====
* If this record is sequence, index_number is number of INDEXes in sequence.
** [{<IndexCount>, <IndexNodeInfo>, <indexDataType>}]
* If this record is sequence
** <IndexCount>: is index of INDEX in table
** <IndexNodeInfo>: is info of index_node
** <indexDataType>: is data type of index_node
* What kind of data will be a sequence node?

===Example===
* The example mchip.txt describe the OID tree given below:
[[File:Snmp mib oid tree example.jpg | thumb | center | 900px]]

* The corresponding binary file is mchip.bin and it has data describe in table below:
[[File:Snmp mib binary example.jpg | thumb | center | 900px]]

OID is <oid> fields.
Info is <nodeInfo> fields.
Dist is [distantSiblingOffset]/[siblingOffset] fields.
Id is [id] fields.
Defval is data fields, include [dataType], [dataLen], [data] fields.
Index is index fields of sequence, include [{index_number} , {<IndexCount>, <IndexNodeInfo>, <indexDataType>, ...}].

* The detail description of mchip.bin is illuminated by structure diagram below can you upload a picture with higher resolution?:
This is picture with higher resolution.
[[File:Snmp mib binary detail example.jpg | thumb | center | 900px]]

The hidden linear is oid tree structure.
The red and green continue linear is pointer of data.
The dist field point to next sibling record. After parent record is it's children.

File:Snmp mib binary detail example.jpg

2010-09-28T17:35:51Z

Thai: uploaded a new version of "File:Snmp mib binary detail example.jpg": id fields's size is changed 1 byte to 4 bytes.

File:Snmp mib binary detail example.jpg

2010-09-28T17:32:47Z

Thai: uploaded a new version of "File:Snmp mib binary detail example.jpg": id fields's size is changed 1 byte to 4 bytes

File:Snmp mib binary example.jpg

2010-09-28T17:29:53Z

Thai: uploaded a new version of "File:Snmp mib binary example.jpg": id fields's size is changed 1 byte to 4 bytes

SNMP MIB Implementation

2010-09-28T17:23:11Z

Thai: /* [id] field */

This wiki describe how to generate a MIB (Management Information Base) for SNMP agent.

==Steps==
# Create a Microchip Custom MIB script '''snmp.mib''' (an ASCII text file) for the tree structure.
# Create a ASN.1 MIB script '''foo.mib''' (an ASCII text file) for the tree structure.
# Convert foo.mib to binary file using '''mib2bin'''
# Build [http://www.rane.com/note161.html snmp's PDU use BER (Base encoding rules)] encoder and decoder library to process data that's transfer between NMS and agents.
# Build snmp API use [http://www.sics.se/~adam/uip/index.php/Main_Page uIP-stack] to communicate between NMS and Agents (open two ports: The manager speak to agents on one port, the agent responds manager on the other port).
# Build binary MIB file reader library.
# Build functions service oid tree.
# Merge MIB ANS.1 file to NMS.

==Create Microchip Custom MIB Script==
* Is this file needed?
don't needed creat Microchip MIB script.
* If so any tutorial to create this file?

==Create ASN.1 MIB Script==
* Build MIB file's written in [http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ANS.1 notation].
* Any tutorial to create this file?

===Abstract Syntax Notation===
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

==Convert MIB to Binary File==
* mib2bin tool is modified from [http://net-snmp.sourceforge.net/ net-snmp] to convert ASN.1 format file to three files, because the microchip '''mib2bib''' converter only supports upto 255 OIDs.
MIB compiler tools: '''mib2bin'''
[http://www.modtronix.com/products/sbc44ec/00870a.pdf foo.mib] (ANS.1 format) -----------------------------------> foo.bin + foo.h + foo_data.h

* Syntax to use mib2bin tool:
'''mib2bin <MIBfile>...
* where MIBfile file is ASN.1 format file. MIBfile = <name>.<type>
** '''<name>.bin''' is the binary file storing information of OID tree. This file can be placed on an SD media card to be read by the FAT16 file system.
** '''<name>_data.h''' is C header file storing information of OID tree. This file is generated by converting mchip.bin file to the C header file. It's only used when a system don't have system file and place on program memory.
** '''<name>.h''' is C header file storing ID that's reference to function service of OID.
* Note:
** Subfolder '''mibs''' containing the basics MIB files (e.g.: RFC1155-SMI, RFC1213-MIB, RFC-1215, SNMPv2-MIB ... for us MIB file), must be present under the directory of execution.
** If the three files exist, mib2bin tool will overwrite the files.

===Binary File Format===
* The binary file is an image of MIB file. It is generated by mib2bin tool. Agents will read binary file to respond NMS request.
* In the binary file, A parent is stored first, followed by its last-child to first-child. Next, the structure of next this parent is stored. This structure is repeated until the entire tree is stored.
* A parent or child is a record. Single record of binary file have format:
<oid>, <nodeInfo>,
[id], [siblingOffset], [distantSiblingOffset], [dataType], [dataLen], [data],
[{<index_number>},{<IndexCount>, <IndexNodeInfo>, <indexDataType>} ...]

where:
fields indicated by angle brackets (< >) are always present
fields in square brackets ([ ]) are optional depending on characteristics of the current node.
fields in braces ({}) are optional but always occur together.

====<oid> field====
* Format of OID:
oid1 char(16)
oid2 char(16)
....
* if oid_i < 254: oid_i = char (oid_i)
* else oid_i = char(255) + char(length of oid_i) + oid_i (base 255) + char(16)
* If this a standard representation, or is a workaround of the microchip format?
This is an workaround to store oids, but this isn't a standard representation or the microchip format.
* What does char(.) mean?
char(x) that's mean get ascii of x.
char(16) is used to separate two oids.
char(255) is determined that oid geater than 254.
"length of oid_i" is length string of oid_i that's converted base 255.

====<nodeInfo> field====
* information of node
bit when (set = 1)
0 Node is a parent (0: node is a leaf)
1 Node is sequence
2 Node is readable
3 Node is writable
4 Node is able to create
5 Node has default data
6 (if node is sequence, this is mean implied index node)
7 always set 1

====[id] field====
* If this record is leaf, id that's reference to function services the record.
* leaf means child?
leaf means child, but child doesn't mean leaf.
the comment fixed.

====[distantSiblingOffset] field====
* If this record is a node [distantSiblingOffset] is enabled. Point to next node sibling.
* root node should have no sibling. How come the example (below) has a distant offset BC000000? Also, is it big-endian or little-endian?

====[siblingOffset] field====
* If this record is a leaf [siblingOffset] is enabled. Point to next leaf sibling.
* I can see some child nodes in the example, but the table does not have any siblingOffset, can you explain?

====[dataType], [dataLen], [data] fields====
* If this record is a leaf and has default data
** [dataType] is type of leaf's data.
** [dataLen] is length of data.
** [data] is data on string.
* How many dataType does it support?

====[{<index_number>}]====
* If this record is sequence, index_number is number of INDEXes in sequence.
** [{<IndexCount>, <IndexNodeInfo>, <indexDataType>}]
* If this record is sequence
** <IndexCount>: is index of INDEX in table
** <IndexNodeInfo>: is info of index_node
** <indexDataType>: is data type of index_node
* What kind of data will be a sequence node?

===Example===
* The example mchip.txt describe the OID tree given below:
[[File:Snmp mib oid tree example.jpg | thumb | center | 900px]]

* The corresponding binary file is mchip.bin and it has data describe in table below:
[[File:Snmp mib binary example.jpg | thumb | center | 900px]]

OID is <oid> fields.
Info is <nodeInfo> fields.
Dist is [distantSiblingOffset]/[siblingOffset] fields.
Id is [id] fields.
Defval is data fields, include [dataType], [dataLen], [data] fields.
Index is index fields of sequence, include [{index_number} , {<IndexCount>, <IndexNodeInfo>, <indexDataType>, ...}].

* The detail description of mchip.bin is illuminated by structure diagram below can you upload a picture with higher resolution?:
[[File:Snmp mib binary detail example.jpg]]

The hidden linear is oid tree structure.
The red and green continue linear is pointer of data.
The dist field point to next sibling record. After parent record is it's children.

SNMP MIB Implementation

2010-09-28T17:20:17Z

Thai: /* field */

This wiki describe how to generate a MIB (Management Information Base) for SNMP agent.

==Steps==
# Create a Microchip Custom MIB script '''snmp.mib''' (an ASCII text file) for the tree structure.
# Create a ASN.1 MIB script '''foo.mib''' (an ASCII text file) for the tree structure.
# Convert foo.mib to binary file using '''mib2bin'''
# Build [http://www.rane.com/note161.html snmp's PDU use BER (Base encoding rules)] encoder and decoder library to process data that's transfer between NMS and agents.
# Build snmp API use [http://www.sics.se/~adam/uip/index.php/Main_Page uIP-stack] to communicate between NMS and Agents (open two ports: The manager speak to agents on one port, the agent responds manager on the other port).
# Build binary MIB file reader library.
# Build functions service oid tree.
# Merge MIB ANS.1 file to NMS.

==Create Microchip Custom MIB Script==
* Is this file needed?
don't needed creat Microchip MIB script.
* If so any tutorial to create this file?

==Create ASN.1 MIB Script==
* Build MIB file's written in [http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ANS.1 notation].
* Any tutorial to create this file?

===Abstract Syntax Notation===
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

==Convert MIB to Binary File==
* mib2bin tool is modified from [http://net-snmp.sourceforge.net/ net-snmp] to convert ASN.1 format file to three files, because the microchip '''mib2bib''' converter only supports upto 255 OIDs.
MIB compiler tools: '''mib2bin'''
[http://www.modtronix.com/products/sbc44ec/00870a.pdf foo.mib] (ANS.1 format) -----------------------------------> foo.bin + foo.h + foo_data.h

* Syntax to use mib2bin tool:
'''mib2bin <MIBfile>...
* where MIBfile file is ASN.1 format file. MIBfile = <name>.<type>
** '''<name>.bin''' is the binary file storing information of OID tree. This file can be placed on an SD media card to be read by the FAT16 file system.
** '''<name>_data.h''' is C header file storing information of OID tree. This file is generated by converting mchip.bin file to the C header file. It's only used when a system don't have system file and place on program memory.
** '''<name>.h''' is C header file storing ID that's reference to function service of OID.
* Note:
** Subfolder '''mibs''' containing the basics MIB files (e.g.: RFC1155-SMI, RFC1213-MIB, RFC-1215, SNMPv2-MIB ... for us MIB file), must be present under the directory of execution.
** If the three files exist, mib2bin tool will overwrite the files.

===Binary File Format===
* The binary file is an image of MIB file. It is generated by mib2bin tool. Agents will read binary file to respond NMS request.
* In the binary file, A parent is stored first, followed by its last-child to first-child. Next, the structure of next this parent is stored. This structure is repeated until the entire tree is stored.
* A parent or child is a record. Single record of binary file have format:
<oid>, <nodeInfo>,
[id], [siblingOffset], [distantSiblingOffset], [dataType], [dataLen], [data],
[{<index_number>},{<IndexCount>, <IndexNodeInfo>, <indexDataType>} ...]

where:
fields indicated by angle brackets (< >) are always present
fields in square brackets ([ ]) are optional depending on characteristics of the current node.
fields in braces ({}) are optional but always occur together.

====<oid> field====
* Format of OID:
oid1 char(16)
oid2 char(16)
....
* if oid_i < 254: oid_i = char (oid_i)
* else oid_i = char(255) + char(length of oid_i) + oid_i (base 255) + char(16)
* If this a standard representation, or is a workaround of the microchip format?
This is an workaround to store oids, but this isn't a standard representation or the microchip format.
* What does char(.) mean?
char(x) that's mean get ascii of x.
char(16) is used to separate two oids.
char(255) is determined that oid geater than 254.
"length of oid_i" is length string of oid_i that's converted base 255.

====<nodeInfo> field====
* information of node
bit when (set = 1)
0 Node is a parent (0: node is a leaf)
1 Node is sequence
2 Node is readable
3 Node is writable
4 Node is able to create
5 Node has default data
6 (if node is sequence, this is mean implied index node)
7 always set 1

====[id] field====
* If this record is leaf, id that's reference to function services the record.
* leaf means child?

====[distantSiblingOffset] field====
* If this record is a node [distantSiblingOffset] is enabled. Point to next node sibling.
* root node should have no sibling. How come the example (below) has a distant offset BC000000? Also, is it big-endian or little-endian?

====[siblingOffset] field====
* If this record is a leaf [siblingOffset] is enabled. Point to next leaf sibling.
* I can see some child nodes in the example, but the table does not have any siblingOffset, can you explain?

====[dataType], [dataLen], [data] fields====
* If this record is a leaf and has default data
** [dataType] is type of leaf's data.
** [dataLen] is length of data.
** [data] is data on string.
* How many dataType does it support?

====[{<index_number>}]====
* If this record is sequence, index_number is number of INDEXes in sequence.
** [{<IndexCount>, <IndexNodeInfo>, <indexDataType>}]
* If this record is sequence
** <IndexCount>: is index of INDEX in table
** <IndexNodeInfo>: is info of index_node
** <indexDataType>: is data type of index_node
* What kind of data will be a sequence node?

===Example===
* The example mchip.txt describe the OID tree given below:
[[File:Snmp mib oid tree example.jpg | thumb | center | 900px]]

* The corresponding binary file is mchip.bin and it has data describe in table below:
[[File:Snmp mib binary example.jpg | thumb | center | 900px]]

OID is <oid> fields.
Info is <nodeInfo> fields.
Dist is [distantSiblingOffset]/[siblingOffset] fields.
Id is [id] fields.
Defval is data fields, include [dataType], [dataLen], [data] fields.
Index is index fields of sequence, include [{index_number} , {<IndexCount>, <IndexNodeInfo>, <indexDataType>, ...}].

* The detail description of mchip.bin is illuminated by structure diagram below can you upload a picture with higher resolution?:
[[File:Snmp mib binary detail example.jpg]]

The hidden linear is oid tree structure.
The red and green continue linear is pointer of data.
The dist field point to next sibling record. After parent record is it's children.

SNMP MIB Implementation

2010-09-28T17:17:05Z

Thai: /* field */

This wiki describe how to generate a MIB (Management Information Base) for SNMP agent.

==Steps==
# Create a Microchip Custom MIB script '''snmp.mib''' (an ASCII text file) for the tree structure.
# Create a ASN.1 MIB script '''foo.mib''' (an ASCII text file) for the tree structure.
# Convert foo.mib to binary file using '''mib2bin'''
# Build [http://www.rane.com/note161.html snmp's PDU use BER (Base encoding rules)] encoder and decoder library to process data that's transfer between NMS and agents.
# Build snmp API use [http://www.sics.se/~adam/uip/index.php/Main_Page uIP-stack] to communicate between NMS and Agents (open two ports: The manager speak to agents on one port, the agent responds manager on the other port).
# Build binary MIB file reader library.
# Build functions service oid tree.
# Merge MIB ANS.1 file to NMS.

==Create Microchip Custom MIB Script==
* Is this file needed?
don't needed creat Microchip MIB script.
* If so any tutorial to create this file?

==Create ASN.1 MIB Script==
* Build MIB file's written in [http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ANS.1 notation].
* Any tutorial to create this file?

===Abstract Syntax Notation===
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

==Convert MIB to Binary File==
* mib2bin tool is modified from [http://net-snmp.sourceforge.net/ net-snmp] to convert ASN.1 format file to three files, because the microchip '''mib2bib''' converter only supports upto 255 OIDs.
MIB compiler tools: '''mib2bin'''
[http://www.modtronix.com/products/sbc44ec/00870a.pdf foo.mib] (ANS.1 format) -----------------------------------> foo.bin + foo.h + foo_data.h

* Syntax to use mib2bin tool:
'''mib2bin <MIBfile>...
* where MIBfile file is ASN.1 format file. MIBfile = <name>.<type>
** '''<name>.bin''' is the binary file storing information of OID tree. This file can be placed on an SD media card to be read by the FAT16 file system.
** '''<name>_data.h''' is C header file storing information of OID tree. This file is generated by converting mchip.bin file to the C header file. It's only used when a system don't have system file and place on program memory.
** '''<name>.h''' is C header file storing ID that's reference to function service of OID.
* Note:
** Subfolder '''mibs''' containing the basics MIB files (e.g.: RFC1155-SMI, RFC1213-MIB, RFC-1215, SNMPv2-MIB ... for us MIB file), must be present under the directory of execution.
** If the three files exist, mib2bin tool will overwrite the files.

===Binary File Format===
* The binary file is an image of MIB file. It is generated by mib2bin tool. Agents will read binary file to respond NMS request.
* In the binary file, A parent is stored first, followed by its last-child to first-child. Next, the structure of next this parent is stored. This structure is repeated until the entire tree is stored.
* A parent or child is a record. Single record of binary file have format:
<oid>, <nodeInfo>,
[id], [siblingOffset], [distantSiblingOffset], [dataType], [dataLen], [data],
[{<index_number>},{<IndexCount>, <IndexNodeInfo>, <indexDataType>} ...]

where:
fields indicated by angle brackets (< >) are always present
fields in square brackets ([ ]) are optional depending on characteristics of the current node.
fields in braces ({}) are optional but always occur together.

====<oid> field====
* Format of OID:
oid1 char(16)
oid2 char(16)
....
* if oid_i < 254: oid_i = char (oid_i)
* else oid_i = char(255) + char(length of oid_i) + oid_i (base 255) + char(16)
* If this a standard representation, or is a workaround of the microchip format?
This is an workaround to store oids, but this isn't a standard representation or the microchip format.
* What does char(.) mean?
char(x) that's mean get ascii of x.
char(16) is used to separate two oids.
char(255) is determined that oid geater than 254.
"length of oid_i" is length string of oid_i that's converted base 255.

====<nodeInfo> field====
* information of node
bit when (set = 1)
0 Node is a parent (0: node is a child)
1 Node is sequence
2 Node is readable
3 Node is writable
4 Node is able to create
5 Node has default data
6 (if node is sequence, this is mean implied index node)
7 always set 1

====[id] field====
* If this record is leaf, id that's reference to function services the record.
* leaf means child?

====[distantSiblingOffset] field====
* If this record is a node [distantSiblingOffset] is enabled. Point to next node sibling.
* root node should have no sibling. How come the example (below) has a distant offset BC000000? Also, is it big-endian or little-endian?

====[siblingOffset] field====
* If this record is a leaf [siblingOffset] is enabled. Point to next leaf sibling.
* I can see some child nodes in the example, but the table does not have any siblingOffset, can you explain?

====[dataType], [dataLen], [data] fields====
* If this record is a leaf and has default data
** [dataType] is type of leaf's data.
** [dataLen] is length of data.
** [data] is data on string.
* How many dataType does it support?

====[{<index_number>}]====
* If this record is sequence, index_number is number of INDEXes in sequence.
** [{<IndexCount>, <IndexNodeInfo>, <indexDataType>}]
* If this record is sequence
** <IndexCount>: is index of INDEX in table
** <IndexNodeInfo>: is info of index_node
** <indexDataType>: is data type of index_node
* What kind of data will be a sequence node?

===Example===
* The example mchip.txt describe the OID tree given below:
[[File:Snmp mib oid tree example.jpg | thumb | center | 900px]]

* The corresponding binary file is mchip.bin and it has data describe in table below:
[[File:Snmp mib binary example.jpg | thumb | center | 900px]]

OID is <oid> fields.
Info is <nodeInfo> fields.
Dist is [distantSiblingOffset]/[siblingOffset] fields.
Id is [id] fields.
Defval is data fields, include [dataType], [dataLen], [data] fields.
Index is index fields of sequence, include [{index_number} , {<IndexCount>, <IndexNodeInfo>, <indexDataType>, ...}].

* The detail description of mchip.bin is illuminated by structure diagram below can you upload a picture with higher resolution?:
[[File:Snmp mib binary detail example.jpg]]

The hidden linear is oid tree structure.
The red and green continue linear is pointer of data.
The dist field point to next sibling record. After parent record is it's children.

SNMP MIB Implementation

2010-09-28T17:16:15Z

Thai: /* Create Microchip Custom MIB Script */

This wiki describe how to generate a MIB (Management Information Base) for SNMP agent.

==Steps==
# Create a Microchip Custom MIB script '''snmp.mib''' (an ASCII text file) for the tree structure.
# Create a ASN.1 MIB script '''foo.mib''' (an ASCII text file) for the tree structure.
# Convert foo.mib to binary file using '''mib2bin'''
# Build [http://www.rane.com/note161.html snmp's PDU use BER (Base encoding rules)] encoder and decoder library to process data that's transfer between NMS and agents.
# Build snmp API use [http://www.sics.se/~adam/uip/index.php/Main_Page uIP-stack] to communicate between NMS and Agents (open two ports: The manager speak to agents on one port, the agent responds manager on the other port).
# Build binary MIB file reader library.
# Build functions service oid tree.
# Merge MIB ANS.1 file to NMS.

==Create Microchip Custom MIB Script==
* Is this file needed?
don't needed creat Microchip MIB script.
* If so any tutorial to create this file?

==Create ASN.1 MIB Script==
* Build MIB file's written in [http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ANS.1 notation].
* Any tutorial to create this file?

===Abstract Syntax Notation===
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

==Convert MIB to Binary File==
* mib2bin tool is modified from [http://net-snmp.sourceforge.net/ net-snmp] to convert ASN.1 format file to three files, because the microchip '''mib2bib''' converter only supports upto 255 OIDs.
MIB compiler tools: '''mib2bin'''
[http://www.modtronix.com/products/sbc44ec/00870a.pdf foo.mib] (ANS.1 format) -----------------------------------> foo.bin + foo.h + foo_data.h

* Syntax to use mib2bin tool:
'''mib2bin <MIBfile>...
* where MIBfile file is ASN.1 format file. MIBfile = <name>.<type>
** '''<name>.bin''' is the binary file storing information of OID tree. This file can be placed on an SD media card to be read by the FAT16 file system.
** '''<name>_data.h''' is C header file storing information of OID tree. This file is generated by converting mchip.bin file to the C header file. It's only used when a system don't have system file and place on program memory.
** '''<name>.h''' is C header file storing ID that's reference to function service of OID.
* Note:
** Subfolder '''mibs''' containing the basics MIB files (e.g.: RFC1155-SMI, RFC1213-MIB, RFC-1215, SNMPv2-MIB ... for us MIB file), must be present under the directory of execution.
** If the three files exist, mib2bin tool will overwrite the files.

===Binary File Format===
* The binary file is an image of MIB file. It is generated by mib2bin tool. Agents will read binary file to respond NMS request.
* In the binary file, A parent is stored first, followed by its last-child to first-child. Next, the structure of next this parent is stored. This structure is repeated until the entire tree is stored.
* A parent or child is a record. Single record of binary file have format:
<oid>, <nodeInfo>,
[id], [siblingOffset], [distantSiblingOffset], [dataType], [dataLen], [data],
[{<index_number>},{<IndexCount>, <IndexNodeInfo>, <indexDataType>} ...]

where:
fields indicated by angle brackets (< >) are always present
fields in square brackets ([ ]) are optional depending on characteristics of the current node.
fields in braces ({}) are optional but always occur together.

====<oid> field====
* Format of OID:
oid1 char(16)
oid2 char(16)
....
* if oid_i < 254: oid_i = char (oid_i)
* else oid_i = char(255) + char(length of oid_i) + oid_i (base 255) + char(16)
* If this a standard representation, or is a workaround of the microchip format?
This is an workaround to store oids, but this isn't a standard representation or the microchip format.
* What does char(.) mean?
char(x) that's mean get ascii of x.
char(16) is used to separate two oids.
char(255) is determined that oid geater than 254.
"length of oid_i" is length string of oid_i that's converted base 255.

====<nodeInfo> field====
* information of node
bit when (set = 1)
0 Node is a parent (0: node is a child)
1 Node is sequence
2 Node is readable
3 Node is writable
4 Node is able to create
5 Node has default data
6 (if node is sequence, this is mean implied index node)
7 always set 1

====[id] field====
* If this record is leaf, id that's reference to function services the record.
* leaf means child?

====[distantSiblingOffset] field====
* If this record is a node [distantSiblingOffset] is enabled. Point to next node sibling.
* root node should have no sibling. How come the example (below) has a distant offset BC000000? Also, is it big-endian or little-endian?

====[siblingOffset] field====
* If this record is a leaf [siblingOffset] is enabled. Point to next leaf sibling.
* I can see some child nodes in the example, but the table does not have any siblingOffset, can you explain?

====[dataType], [dataLen], [data] fields====
* If this record is a leaf and has default data
** [dataType] is type of leaf's data.
** [dataLen] is length of data.
** [data] is data on string.
* How many dataType does it support?

====[{<index_number>}]====
* If this record is sequence, index_number is number of INDEXes in sequence.
** [{<IndexCount>, <IndexNodeInfo>, <indexDataType>}]
* If this record is sequence
** <IndexCount>: is index of INDEX in table
** <IndexNodeInfo>: is info of index_node
** <indexDataType>: is data type of index_node
* What kind of data will be a sequence node?

===Example===
* The example mchip.txt describe the OID tree given below:
[[File:Snmp mib oid tree example.jpg | thumb | center | 900px]]

* The corresponding binary file is mchip.bin and it has data describe in table below:
[[File:Snmp mib binary example.jpg | thumb | center | 900px]]

OID is <oid> fields.
Info is <nodeInfo> fields.
Dist is [distantSiblingOffset]/[siblingOffset] fields.
Id is [id] fields.
Defval is data fields, include [dataType], [dataLen], [data] fields.
Index is index fields of sequence, include [{index_number} , {<IndexCount>, <IndexNodeInfo>, <indexDataType>, ...}].

* The detail description of mchip.bin is illuminated by structure diagram below can you upload a picture with higher resolution?:
[[File:Snmp mib binary detail example.jpg]]

The hidden linear is oid tree structure.
The red and green continue linear is pointer of data.
The dist field point to next sibling record. After parent record is it's children.

SNMP MIB Implementation

2010-09-28T17:15:01Z

Thai: /* field */

This wiki describe how to generate a MIB (Management Information Base) for SNMP agent.

==Steps==
# Create a Microchip Custom MIB script '''snmp.mib''' (an ASCII text file) for the tree structure.
# Create a ASN.1 MIB script '''foo.mib''' (an ASCII text file) for the tree structure.
# Convert foo.mib to binary file using '''mib2bin'''
# Build [http://www.rane.com/note161.html snmp's PDU use BER (Base encoding rules)] encoder and decoder library to process data that's transfer between NMS and agents.
# Build snmp API use [http://www.sics.se/~adam/uip/index.php/Main_Page uIP-stack] to communicate between NMS and Agents (open two ports: The manager speak to agents on one port, the agent responds manager on the other port).
# Build binary MIB file reader library.
# Build functions service oid tree.
# Merge MIB ANS.1 file to NMS.

==Create Microchip Custom MIB Script==
* Is this file needed?
don't needed creat Microchip MIB script.
* If so any tutorial to create this file?

==Create ASN.1 MIB Script==
* Build MIB file's written in [http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ANS.1 notation].
* Any tutorial to create this file?

===Abstract Syntax Notation===
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

==Convert MIB to Binary File==
* mib2bin tool is modified from [http://net-snmp.sourceforge.net/ net-snmp] to convert ASN.1 format file to three files, because the microchip '''mib2bib''' converter only supports upto 255 OIDs.
MIB compiler tools: '''mib2bin'''
[http://www.modtronix.com/products/sbc44ec/00870a.pdf foo.mib] (ANS.1 format) -----------------------------------> foo.bin + foo.h + foo_data.h

* Syntax to use mib2bin tool:
'''mib2bin <MIBfile>...
* where MIBfile file is ASN.1 format file. MIBfile = <name>.<type>
** '''<name>.bin''' is the binary file storing information of OID tree. This file can be placed on an SD media card to be read by the FAT16 file system.
** '''<name>_data.h''' is C header file storing information of OID tree. This file is generated by converting mchip.bin file to the C header file. It's only used when a system don't have system file and place on program memory.
** '''<name>.h''' is C header file storing ID that's reference to function service of OID.
* Note:
** Subfolder '''mibs''' containing the basics MIB files (e.g.: RFC1155-SMI, RFC1213-MIB, RFC-1215, SNMPv2-MIB ... for us MIB file), must be present under the directory of execution.
** If the three files exist, mib2bin tool will overwrite the files.

===Binary File Format===
* The binary file is an image of MIB file. It is generated by mib2bin tool. Agents will read binary file to respond NMS request.
* In the binary file, A parent is stored first, followed by its last-child to first-child. Next, the structure of next this parent is stored. This structure is repeated until the entire tree is stored.
* A parent or child is a record. Single record of binary file have format:
<oid>, <nodeInfo>,
[id], [siblingOffset], [distantSiblingOffset], [dataType], [dataLen], [data],
[{<index_number>},{<IndexCount>, <IndexNodeInfo>, <indexDataType>} ...]

where:
fields indicated by angle brackets (< >) are always present
fields in square brackets ([ ]) are optional depending on characteristics of the current node.
fields in braces ({}) are optional but always occur together.

====<oid> field====
* Format of OID:
oid1 char(16)
oid2 char(16)
....
* if oid_i < 254: oid_i = char (oid_i)
* else oid_i = char(255) + char(length of oid_i) + oid_i (base 255) + char(16)
* If this a standard representation, or is a workaround of the microchip format?
This is an workaround to store oids, but this isn't a standard representation or the microchip format.
* What does char(.) mean?
char(x) that's mean get ascii of x.
char(16) is used to separate two oids.
char(255) is determined that oid geater than 254.
"length of oid_i" is length string of oid_i that's converted base 255.

====<nodeInfo> field====
* information of node
bit when (set = 1)
0 Node is a parent (0: node is a child)
1 Node is sequence
2 Node is readable
3 Node is writable
4 Node is able to create
5 Node has default data
6 (if node is sequence, this is mean implied index node)
7 always set 1

====[id] field====
* If this record is leaf, id that's reference to function services the record.
* leaf means child?

====[distantSiblingOffset] field====
* If this record is a node [distantSiblingOffset] is enabled. Point to next node sibling.
* root node should have no sibling. How come the example (below) has a distant offset BC000000? Also, is it big-endian or little-endian?

====[siblingOffset] field====
* If this record is a leaf [siblingOffset] is enabled. Point to next leaf sibling.
* I can see some child nodes in the example, but the table does not have any siblingOffset, can you explain?

====[dataType], [dataLen], [data] fields====
* If this record is a leaf and has default data
** [dataType] is type of leaf's data.
** [dataLen] is length of data.
** [data] is data on string.
* How many dataType does it support?

====[{<index_number>}]====
* If this record is sequence, index_number is number of INDEXes in sequence.
** [{<IndexCount>, <IndexNodeInfo>, <indexDataType>}]
* If this record is sequence
** <IndexCount>: is index of INDEX in table
** <IndexNodeInfo>: is info of index_node
** <indexDataType>: is data type of index_node
* What kind of data will be a sequence node?

===Example===
* The example mchip.txt describe the OID tree given below:
[[File:Snmp mib oid tree example.jpg | thumb | center | 900px]]

* The corresponding binary file is mchip.bin and it has data describe in table below:
[[File:Snmp mib binary example.jpg | thumb | center | 900px]]

OID is <oid> fields.
Info is <nodeInfo> fields.
Dist is [distantSiblingOffset]/[siblingOffset] fields.
Id is [id] fields.
Defval is data fields, include [dataType], [dataLen], [data] fields.
Index is index fields of sequence, include [{index_number} , {<IndexCount>, <IndexNodeInfo>, <indexDataType>, ...}].

* The detail description of mchip.bin is illuminated by structure diagram below can you upload a picture with higher resolution?:
[[File:Snmp mib binary detail example.jpg]]

The hidden linear is oid tree structure.
The red and green continue linear is pointer of data.
The dist field point to next sibling record. After parent record is it's children.

SNMP MIB Implementation

2010-09-28T16:40:47Z

Thai: /* Create Microchip Custom MIB Script */

This wiki describe how to generate a MIB (Management Information Base) for SNMP agent.

==Steps==
# Create a Microchip Custom MIB script '''snmp.mib''' (an ASCII text file) for the tree structure.
# Create a ASN.1 MIB script '''foo.mib''' (an ASCII text file) for the tree structure.
# Convert foo.mib to binary file using '''mib2bin'''
# Build [http://www.rane.com/note161.html snmp's PDU use BER (Base encoding rules)] encoder and decoder library to process data that's transfer between NMS and agents.
# Build snmp API use [http://www.sics.se/~adam/uip/index.php/Main_Page uIP-stack] to communicate between NMS and Agents (open two ports: The manager speak to agents on one port, the agent responds manager on the other port).
# Build binary MIB file reader library.
# Build functions service oid tree.
# Merge MIB ANS.1 file to NMS.

==Create Microchip Custom MIB Script==
* Is this file needed?
don't needed creat Microchip MIB script.
* If so any tutorial to create this file?

==Create ASN.1 MIB Script==
* Build MIB file's written in [http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ANS.1 notation].
* Any tutorial to create this file?

===Abstract Syntax Notation===
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

==Convert MIB to Binary File==
* mib2bin tool is modified from [http://net-snmp.sourceforge.net/ net-snmp] to convert ASN.1 format file to three files, because the microchip '''mib2bib''' converter only supports upto 255 OIDs.
MIB compiler tools: '''mib2bin'''
[http://www.modtronix.com/products/sbc44ec/00870a.pdf foo.mib] (ANS.1 format) -----------------------------------> foo.bin + foo.h + foo_data.h

* Syntax to use mib2bin tool:
'''mib2bin <MIBfile>...
* where MIBfile file is ASN.1 format file. MIBfile = <name>.<type>
** '''<name>.bin''' is the binary file storing information of OID tree. This file can be placed on an SD media card to be read by the FAT16 file system.
** '''<name>_data.h''' is C header file storing information of OID tree. This file is generated by converting mchip.bin file to the C header file. It's only used when a system don't have system file and place on program memory.
** '''<name>.h''' is C header file storing ID that's reference to function service of OID.
* Note:
** Subfolder '''mibs''' containing the basics MIB files (e.g.: RFC1155-SMI, RFC1213-MIB, RFC-1215, SNMPv2-MIB ... for us MIB file), must be present under the directory of execution.
** If the three files exist, mib2bin tool will overwrite the files.

===Binary File Format===
* The binary file is an image of MIB file. It is generated by mib2bin tool. Agents will read binary file to respond NMS request.
* In the binary file, A parent is stored first, followed by its last-child to first-child. Next, the structure of next this parent is stored. This structure is repeated until the entire tree is stored.
* A parent or child is a record. Single record of binary file have format:
<oid>, <nodeInfo>,
[id], [siblingOffset], [distantSiblingOffset], [dataType], [dataLen], [data],
[{<index_number>},{<IndexCount>, <IndexNodeInfo>, <indexDataType>} ...]

where:
fields indicated by angle brackets (< >) are always present
fields in square brackets ([ ]) are optional depending on characteristics of the current node.
fields in braces ({}) are optional but always occur together.

====<oid> field====
* Format of OID:
oid1 char(16)
oid2 char(16)
....
* if oid_i < 254: oid_i = char (oid_i)
* else oid_i = char(255) + char(length of oid_i) + oid_i (base on 255) + char(16)
* If this a standard representation, or is a workaround of the microchip format?
* What does char(.) mean?

====<nodeInfo> field====
* information of node
bit when (set = 1)
0 Node is a parent (0: node is a child)
1 Node is sequence
2 Node is readable
3 Node is writable
4 Node is able to create
5 Node has default data
6 (if node is sequence, this is mean implied index node)
7 always set 1

====[id] field====
* If this record is leaf, id that's reference to function services the record.
* leaf means child?

====[distantSiblingOffset] field====
* If this record is a node [distantSiblingOffset] is enabled. Point to next node sibling.
* root node should have no sibling. How come the example (below) has a distant offset BC000000? Also, is it big-endian or little-endian?

====[siblingOffset] field====
* If this record is a leaf [siblingOffset] is enabled. Point to next leaf sibling.
* I can see some child nodes in the example, but the table does not have any siblingOffset, can you explain?

====[dataType], [dataLen], [data] fields====
* If this record is a leaf and has default data
** [dataType] is type of leaf's data.
** [dataLen] is length of data.
** [data] is data on string.
* How many dataType does it support?

====[{<index_number>}]====
* If this record is sequence, index_number is number of INDEXes in sequence.
** [{<IndexCount>, <IndexNodeInfo>, <indexDataType>}]
* If this record is sequence
** <IndexCount>: is index of INDEX in table
** <IndexNodeInfo>: is info of index_node
** <indexDataType>: is data type of index_node
* What kind of data will be a sequence node?

===Example===
* The example mchip.txt describe the OID tree given below:
[[File:Snmp mib oid tree example.jpg | thumb | center | 900px]]

* The corresponding binary file is mchip.bin and it has data describe in table below:
[[File:Snmp mib binary example.jpg | thumb | center | 900px]]

OID is <oid> fields.
Info is <nodeInfo> fields.
Dist is [distantSiblingOffset]/[siblingOffset] fields.
Id is [id] fields.
Defval is data fields, include [dataType], [dataLen], [data] fields.
Index is index fields of sequence, include [{index_number} , {<IndexCount>, <IndexNodeInfo>, <indexDataType>, ...}].

* The detail description of mchip.bin is illuminated by structure diagram below can you upload a picture with higher resolution?:
[[File:Snmp mib binary detail example.jpg]]

The hidden linear is oid tree structure.
The red and green continue linear is pointer of data.
The dist field point to next sibling record. After parent record is it's children.

File:Snmp mib binary detail example.jpg

2010-09-28T13:57:55Z

Thai: uploaded a new version of "File:Snmp mib binary detail example.jpg": mib structure on diagram

UIP

2010-08-23T15:48:24Z

Thai: /* To-Do List */

This wiki describes how to use uIP (a Light-weight TCP/IP stack) for developing ethernet applications for 8/16-bit embedded system (see [{{SERVER}}/Ethernet_Module Ethernet_Module]).

==Introduction==
*Developed by Adam Dunkels of the Networked Embedded Systems group at the Swedish Institute of Computer Science.
*[http://www.sics.se/~adam/uip/ uIP] is under the [http://www.sics.se/~adam/uip/index.php/License BSD-style license]

==Bug List==
*DHCP
**dhcp client fault from buffalo router
**occasionally cannot access webserver with dhcp
*DHCP
**dhcp client fault from main router
**occasionally cannot access webserver with dhcp
**possible cause: module tries to get IP configuration when switching on and off too frequently. This causes the router to enter into an unknown state. Even using the static mode with the same IP cannot get Internet access properly. When wait for some time and switch on the module again, the router may have been "reset", and the connection is ok again.
*SMTP
**some router cannot used SMTP module
**the router return its own IP as DNS resolver, and it does support only parsing direct IP function
**desktop applications (e.g. outlook, thunderbird, webmail) do not use DNS resolver (UDP application) to connect to the mail server, but use TCP/IP to do the job

==To-Do List==
*32kB constant limitations
**see if webserver can be stored in flash in file system
*[{{SERVER}}/Ethernet_Module#SNMP_Agent SNMP]
**porting snmp to uip
**reference to lwip
**a API(or any method) to let other system to talk to our device OR by scpi, modbus
*https by SSL
**on chip SSL(more faster) OR software SSL(need to upgrade CPU power to process the calculation)
**reference - http://www.networkworld.com/news/tech/2002/0729tech.html

==Porting==
===CVS Repository===
{|border="1" cellspacing="0" cellpadding="5"
! Attribute !! Value
|-valign="top"
| Host || uip-stack.cvs.sourceforge.net
|-
| Repository Path || /cvsroot/uip-stack
|-
| Connection Type || pserver
|-
| User || anonymous
|-
|}

===Patches===
*Changes made to CVS Repository for porting to [http://chungyan5.no-ip.org/vc/?root=freertos_posix freertos_posix]
*uip-patch-1.0-01.diff (minimal)
**'''uip.c'''
***Comment out all DEBUG_PRINTF(...) in lines 1, 323, 910, 1015, 1070, 1863, 1868, 1869
*uip-patch-1.0-02.diff (for pic30-elf-gcc compiler v3.01 or above)
**'''uip.h'''
***Change line 1070 to # define HTONS(n) (u16_t)(((((u16_t) (n)) << 8)&0xff00) | ((((u16_t) (n)) >> 8)&0x00ff))
**'''psock.c'''
***Change line 188 to s->sendptr = (u8_t*) buf;
***Change lines 276, 303 to buf_setup(&psock->buf, (u8_t*)(psock->bufptr), psock->bufsize);
***Change line 334 to buf_setup(&psock->buf, (u8_t*)buffer, buffersize);

===Implementation===
*Include the following files to use the uIP stack
**timer.c
**uip.c
**uip_arp.c
**psock.c
*The following files have been created to port uIP 1.0 to dsPic33F development board using FreeRTOS
*[http://chungyan5.no-ip.org/vc/trunk/demo_posix/dspic/drivers/?root=freertos_posix clock-arch.c]: return the os tick counts since the system is turned on.
*[http://chungyan5.no-ip.org/vc/trunk/demo_posix/dspic/drivers/include/?root=freertos_posix clock-arch.h]: a constant specifying the number of os ticks in one second.
*uip-config.h: configuration for your application.

==uIP Ethernet Application==
*The following applications are modified from the demo applications in uIP.

===DHCP Client===
*Use project [http://chungyan5.no-ip.org/vc/?root=dhcpc_8bit dhcpc_8bit]
*Enable UDP in "uip-config.h"
#define UIP_CONF_UDP 1
*Make sure your uip buffer size is large enough (DHCP messages from some servers can be more than 500 bytes). In my setting, I use 1536 in "uip-config.h"
#define UIP_CONF_BUFFER_SIZE 1536

===Web Server===
*Use project [http://chungyan5.no-ip.org/vc/?root=webserver_8bit webserver_8bit]
====add-on====
*The Web Server included in uIP 1.0 has been designed to load/reload the entire page (either html/shtml files) in response to a HTTP GET command, e.g.
GET /index.html HTTP/1.1
GET /abc.shtml HTTP/1.1
*As a result, if the webpage is required to refresh the dynamic data periodically, the surfing experience will be degraded by the large transfer of datastream.
*In consideration of the above issue, a solution is proposed here, so that the webserver can handle this kind of cgi HTTP-request
GET /abc.shtml?val=500.0&button=Set HTTP/1.1

===DNS Resolver===
*Use project [http://chungyan5.no-ip.org/vc/?root=dns_resolv_8bit dns_resolv_8bit]
*The uIP DNS resolver functions are used to lookup a hostname and map it to a numerical IP address. It maintains a list of resolved hostnames that can be queried with the resolv_lookup() function. New hostnames can be resolved using the resolv_query() function.
*When a hostname has been resolved (or found to be non-existant), the resolver code calls a callback function called resolv_found() that must be implemented by the module that uses the resolver.
*Router Setting
**Special attention should be paid to router setting, when the DNS Server address is acquired by DHCP.
**The DNS Resolver module assumes that the DNS server can support DNS TYPE of ANY, MX, CNAME and A. See http://www.networksorcery.com/enp/protocol/dns.htm for definitions of these options.
*In case the router itself does not support these options, the router should be set to deliver a DNS Server address which support these options.

===SMTP Mail Client===
*Use project [http://chungyan5.no-ip.org/vc/?root=smtpc_8bit smtpc_8bit]
*The SMTP client searches the ip address of the mail server by a DNS call. It then logins to the server with the email account name and address using AUTH LOGIN. If login is successful, the mail is sent to the list of recipients.

===SNMP Agent (Not implemented yet)===
*Simple Network Management Protocol (SNMP) is a standard protocol to access variables to remote device via the Internet. Reference in [http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol wikipedia.org]
*It belongs to the Application Layer, as in HTTP.
*If a device is SNMP compatible, any SNMP compatible host system can monitor and control that device.

====Components in a SNMP System====
*Network Management Station (NMS)
**This is a client, initiating SNMP communication.
**This can be a PC with an NMS software (e.g. [http://nino.sourceforge.net/nino/index.html NINO]), polling data from the SNMP agents periodically.
*SNMP Agents
**These are servers, responding to one or multiple NMS requests.
*Management Information Base (MIB)
**A special collection of variables managed by the SNMP agents.
**MIB has a tree-like structure.
**An Object Identifier (OID) is given for each node.
**Data are stored at the end-nodes.
**Private variables may be constructed under the "enterprise" sub-tree.
**The OID for "enterprise" can be obtained from [http://www.iana.org/cgi-bin/enterprise.pl Internet Assigned Number Authority (IANA)].

====Abstract Syntax Notation====
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

====To-Do List====
*Build MIB file.
**Build MIB file's written in [http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ANS.1 notation].
**Build MIB compiler tool to compile MIB file to binary file (store tree structure: oid, id, data type, value, position) and C header file (store id to determine a function service the oid).
**Build MIB converter tool to convert binary MIB file to C header file (embedded to code). Note: binary MIB file can store in MMC/SD card (don't need MIB converter tool).

[https://www.ee.buu.ac.th/~acitl/EthernetMini/MCHPTCPStack%203.75/mib2bib.exe MIB compiler tools]
[http://www.modtronix.com/products/sbc44ec/00870a.pdf foo.mib] (ANS.1 format) -----------------------------------> foo.bin + oid.h (store ID that's reference to function service of OID)

MIB converter tools
foo.bin -----------------------------------> foo.h (store the structure of OID tree)

*Build [http://www.rane.com/note161.html snmp's PDU use BER (Base encoding rules)] encoder and decoder library to process data that's transfer between NMS and agents.
*Build snmp API use [http://www.sics.se/~adam/uip/index.php/Main_Page uIP-stack] to communicate between NMS and Agents (open two ports: The manager speak to agents on one port, the agent responds manager on the other port).
*Build binary MIB file reader library.
*Build functions service oid tree.
*Merge MIB ANS.1 file to NMS.

==Reference==
===uIP===
*[http://www.sics.se/~adam/uip/index.php/Main_Page uIP Description]
*[http://www.sics.se/~adam/uip/index.php/Documentation uIP Documentation]
*[http://www.sics.se/~adam/uip/index.php/Download Download]
*[http://sourceforge.net/cvs/?group_id=186227 CVS Repository]
===lwIP===
*[http://savannah.nongnu.org/projects/lwip/ lwIP Description]
*[http://www.nongnu.org/lwip/ Documentation]
===HTML===
*[http://www.w3schools.com/default.asp W3 Schools]: Learning how to write HTML and JavaScript
===SNMP===
*[http://www.snmplink.org SNMP Link]: Information on SNMP Agents
*[http://pen.iana.org/pen/PenApplication.page IANA]: Applying a Private Enterprise Number
*[http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ASN.1]: Abstract Syntax Notation One (ASN.1):Specification of basic notation

UIP

2010-08-23T15:47:20Z

Thai: /* To-Do List */

This wiki describes how to use uIP (a Light-weight TCP/IP stack) for developing ethernet applications for 8/16-bit embedded system (see [{{SERVER}}/Ethernet_Module Ethernet_Module]).

==Introduction==
*Developed by Adam Dunkels of the Networked Embedded Systems group at the Swedish Institute of Computer Science.
*[http://www.sics.se/~adam/uip/ uIP] is under the [http://www.sics.se/~adam/uip/index.php/License BSD-style license]

==Bug List==
*DHCP
**dhcp client fault from buffalo router
**occasionally cannot access webserver with dhcp
*DHCP
**dhcp client fault from main router
**occasionally cannot access webserver with dhcp
**possible cause: module tries to get IP configuration when switching on and off too frequently. This causes the router to enter into an unknown state. Even using the static mode with the same IP cannot get Internet access properly. When wait for some time and switch on the module again, the router may have been "reset", and the connection is ok again.
*SMTP
**some router cannot used SMTP module
**the router return its own IP as DNS resolver, and it does support only parsing direct IP function
**desktop applications (e.g. outlook, thunderbird, webmail) do not use DNS resolver (UDP application) to connect to the mail server, but use TCP/IP to do the job

==To-Do List==
*32kB constant limitations
**see if webserver can be stored in flash in file system
*[{{SERVER}}/Ethernet_Module#SNMP_Agent SNMP]
**porting snmp to uip
**reference to lwip
**a API(or any method) to let other system to talk to our device OR by scpi, modbus
*https by SSL
**on chip SSL(more faster) OR software SSL(need to upgrade CPU power to process the calculation)
**reference - http://www.networkworld.com/news/tech/2002/0729tech.html

==Porting==
===CVS Repository===
{|border="1" cellspacing="0" cellpadding="5"
! Attribute !! Value
|-valign="top"
| Host || uip-stack.cvs.sourceforge.net
|-
| Repository Path || /cvsroot/uip-stack
|-
| Connection Type || pserver
|-
| User || anonymous
|-
|}

===Patches===
*Changes made to CVS Repository for porting to [http://chungyan5.no-ip.org/vc/?root=freertos_posix freertos_posix]
*uip-patch-1.0-01.diff (minimal)
**'''uip.c'''
***Comment out all DEBUG_PRINTF(...) in lines 1, 323, 910, 1015, 1070, 1863, 1868, 1869
*uip-patch-1.0-02.diff (for pic30-elf-gcc compiler v3.01 or above)
**'''uip.h'''
***Change line 1070 to # define HTONS(n) (u16_t)(((((u16_t) (n)) << 8)&0xff00) | ((((u16_t) (n)) >> 8)&0x00ff))
**'''psock.c'''
***Change line 188 to s->sendptr = (u8_t*) buf;
***Change lines 276, 303 to buf_setup(&psock->buf, (u8_t*)(psock->bufptr), psock->bufsize);
***Change line 334 to buf_setup(&psock->buf, (u8_t*)buffer, buffersize);

===Implementation===
*Include the following files to use the uIP stack
**timer.c
**uip.c
**uip_arp.c
**psock.c
*The following files have been created to port uIP 1.0 to dsPic33F development board using FreeRTOS
*[http://chungyan5.no-ip.org/vc/trunk/demo_posix/dspic/drivers/?root=freertos_posix clock-arch.c]: return the os tick counts since the system is turned on.
*[http://chungyan5.no-ip.org/vc/trunk/demo_posix/dspic/drivers/include/?root=freertos_posix clock-arch.h]: a constant specifying the number of os ticks in one second.
*uip-config.h: configuration for your application.

==uIP Ethernet Application==
*The following applications are modified from the demo applications in uIP.

===DHCP Client===
*Use project [http://chungyan5.no-ip.org/vc/?root=dhcpc_8bit dhcpc_8bit]
*Enable UDP in "uip-config.h"
#define UIP_CONF_UDP 1
*Make sure your uip buffer size is large enough (DHCP messages from some servers can be more than 500 bytes). In my setting, I use 1536 in "uip-config.h"
#define UIP_CONF_BUFFER_SIZE 1536

===Web Server===
*Use project [http://chungyan5.no-ip.org/vc/?root=webserver_8bit webserver_8bit]
====add-on====
*The Web Server included in uIP 1.0 has been designed to load/reload the entire page (either html/shtml files) in response to a HTTP GET command, e.g.
GET /index.html HTTP/1.1
GET /abc.shtml HTTP/1.1
*As a result, if the webpage is required to refresh the dynamic data periodically, the surfing experience will be degraded by the large transfer of datastream.
*In consideration of the above issue, a solution is proposed here, so that the webserver can handle this kind of cgi HTTP-request
GET /abc.shtml?val=500.0&button=Set HTTP/1.1

===DNS Resolver===
*Use project [http://chungyan5.no-ip.org/vc/?root=dns_resolv_8bit dns_resolv_8bit]
*The uIP DNS resolver functions are used to lookup a hostname and map it to a numerical IP address. It maintains a list of resolved hostnames that can be queried with the resolv_lookup() function. New hostnames can be resolved using the resolv_query() function.
*When a hostname has been resolved (or found to be non-existant), the resolver code calls a callback function called resolv_found() that must be implemented by the module that uses the resolver.
*Router Setting
**Special attention should be paid to router setting, when the DNS Server address is acquired by DHCP.
**The DNS Resolver module assumes that the DNS server can support DNS TYPE of ANY, MX, CNAME and A. See http://www.networksorcery.com/enp/protocol/dns.htm for definitions of these options.
*In case the router itself does not support these options, the router should be set to deliver a DNS Server address which support these options.

===SMTP Mail Client===
*Use project [http://chungyan5.no-ip.org/vc/?root=smtpc_8bit smtpc_8bit]
*The SMTP client searches the ip address of the mail server by a DNS call. It then logins to the server with the email account name and address using AUTH LOGIN. If login is successful, the mail is sent to the list of recipients.

===SNMP Agent (Not implemented yet)===
*Simple Network Management Protocol (SNMP) is a standard protocol to access variables to remote device via the Internet. Reference in [http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol wikipedia.org]
*It belongs to the Application Layer, as in HTTP.
*If a device is SNMP compatible, any SNMP compatible host system can monitor and control that device.

====Components in a SNMP System====
*Network Management Station (NMS)
**This is a client, initiating SNMP communication.
**This can be a PC with an NMS software (e.g. [http://nino.sourceforge.net/nino/index.html NINO]), polling data from the SNMP agents periodically.
*SNMP Agents
**These are servers, responding to one or multiple NMS requests.
*Management Information Base (MIB)
**A special collection of variables managed by the SNMP agents.
**MIB has a tree-like structure.
**An Object Identifier (OID) is given for each node.
**Data are stored at the end-nodes.
**Private variables may be constructed under the "enterprise" sub-tree.
**The OID for "enterprise" can be obtained from [http://www.iana.org/cgi-bin/enterprise.pl Internet Assigned Number Authority (IANA)].

====Abstract Syntax Notation====
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

====To-Do List====
*Build MIB file.
**Build MIB file's written in [http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ANS.1 notation].
**Build MIB compiler tool to compile MIB file to binary file (store tree structure: oid, id, data type, value, position) and C header file (store id to determine a function service the oid).

MIB scripts to foo.bin + oid.h
**Build MIB converter tool to convert binary MIB file to C header file (embedded to code). Note: binary MIB file can store in MMC/SD card (don't need MIB converter tool).

[https://www.ee.buu.ac.th/~acitl/EthernetMini/MCHPTCPStack%203.75/mib2bib.exe MIB compiler tools]
[http://www.modtronix.com/products/sbc44ec/00870a.pdf foo.mib] (ANS.1 format) -----------------------------------> foo.bin + oid.h (store ID that's reference to function service of OID)

MIB converter tools
foo.bin -----------------------------------> foo.h (store the structure of OID tree)

*Build [http://www.rane.com/note161.html snmp's PDU use BER (Base encoding rules)] encoder and decoder library to process data that's transfer between NMS and agents.
*Build snmp API use [http://www.sics.se/~adam/uip/index.php/Main_Page uIP-stack] to communicate between NMS and Agents (open two ports: The manager speak to agents on one port, the agent responds manager on the other port).
*Build binary MIB file reader library.
*Build functions service oid tree.
*Merge MIB ANS.1 file to NMS.

==Reference==
===uIP===
*[http://www.sics.se/~adam/uip/index.php/Main_Page uIP Description]
*[http://www.sics.se/~adam/uip/index.php/Documentation uIP Documentation]
*[http://www.sics.se/~adam/uip/index.php/Download Download]
*[http://sourceforge.net/cvs/?group_id=186227 CVS Repository]
===lwIP===
*[http://savannah.nongnu.org/projects/lwip/ lwIP Description]
*[http://www.nongnu.org/lwip/ Documentation]
===HTML===
*[http://www.w3schools.com/default.asp W3 Schools]: Learning how to write HTML and JavaScript
===SNMP===
*[http://www.snmplink.org SNMP Link]: Information on SNMP Agents
*[http://pen.iana.org/pen/PenApplication.page IANA]: Applying a Private Enterprise Number
*[http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ASN.1]: Abstract Syntax Notation One (ASN.1):Specification of basic notation

UIP

2010-08-04T16:36:24Z

Thai: /* To-Do List */

This wiki describes how to use uIP (a Light-weight TCP/IP stack) for developing ethernet applications for 8/16-bit embedded system (see [{{SERVER}}/Ethernet_Module Ethernet_Module]).

==Introduction==
*Developed by Adam Dunkels of the Networked Embedded Systems group at the Swedish Institute of Computer Science.
*[http://www.sics.se/~adam/uip/ uIP] is under the [http://www.sics.se/~adam/uip/index.php/License BSD-style license]

==Bug List==
*DHCP
**dhcp client fault from buffalo router
**occasionally cannot access webserver with dhcp
*DHCP
**dhcp client fault from main router
**occasionally cannot access webserver with dhcp
**possible cause: module tries to get IP configuration when switching on and off too frequently. This causes the router to enter into an unknown state. Even using the static mode with the same IP cannot get Internet access properly. When wait for some time and switch on the module again, the router may have been "reset", and the connection is ok again.
*SMTP
**some router cannot used SMTP module
**the router return its own IP as DNS resolver, and it does support only parsing direct IP function
**desktop applications (e.g. outlook, thunderbird, webmail) do not use DNS resolver (UDP application) to connect to the mail server, but use TCP/IP to do the job

==To-Do List==
*32kB constant limitations
**see if webserver can be stored in flash in file system
*[{{SERVER}}/Ethernet_Module#SNMP_Agent SNMP]
**porting snmp to uip
**reference to lwip
**a API(or any method) to let other system to talk to our device OR by scpi, modbus
*https by SSL
**on chip SSL(more faster) OR software SSL(need to upgrade CPU power to process the calculation)
**reference - http://www.networkworld.com/news/tech/2002/0729tech.html

==Porting==
===CVS Repository===
{|border="1" cellspacing="0" cellpadding="5"
! Attribute !! Value
|-valign="top"
| Host || uip-stack.cvs.sourceforge.net
|-
| Repository Path || /cvsroot/uip-stack
|-
| Connection Type || pserver
|-
| User || anonymous
|-
|}

===Patches===
*Changes made to CVS Repository for porting to [http://chungyan5.no-ip.org/vc/?root=freertos_posix freertos_posix]
*uip-patch-1.0-01.diff (minimal)
**'''uip.c'''
***Comment out all DEBUG_PRINTF(...) in lines 1, 323, 910, 1015, 1070, 1863, 1868, 1869
*uip-patch-1.0-02.diff (for pic30-elf-gcc compiler v3.01 or above)
**'''uip.h'''
***Change line 1070 to # define HTONS(n) (u16_t)(((((u16_t) (n)) << 8)&0xff00) | ((((u16_t) (n)) >> 8)&0x00ff))
**'''psock.c'''
***Change line 188 to s->sendptr = (u8_t*) buf;
***Change lines 276, 303 to buf_setup(&psock->buf, (u8_t*)(psock->bufptr), psock->bufsize);
***Change line 334 to buf_setup(&psock->buf, (u8_t*)buffer, buffersize);

===Implementation===
*Include the following files to use the uIP stack
**timer.c
**uip.c
**uip_arp.c
**psock.c
*The following files have been created to port uIP 1.0 to dsPic33F development board using FreeRTOS
*[http://chungyan5.no-ip.org/vc/trunk/demo_posix/dspic/drivers/?root=freertos_posix clock-arch.c]: return the os tick counts since the system is turned on.
*[http://chungyan5.no-ip.org/vc/trunk/demo_posix/dspic/drivers/include/?root=freertos_posix clock-arch.h]: a constant specifying the number of os ticks in one second.
*uip-config.h: configuration for your application.

==uIP Ethernet Application==
*The following applications are modified from the demo applications in uIP.

===DHCP Client===
*Use project [http://chungyan5.no-ip.org/vc/?root=dhcpc_8bit dhcpc_8bit]
*Enable UDP in "uip-config.h"
#define UIP_CONF_UDP 1
*Make sure your uip buffer size is large enough (DHCP messages from some servers can be more than 500 bytes). In my setting, I use 1536 in "uip-config.h"
#define UIP_CONF_BUFFER_SIZE 1536

===Web Server===
*Use project [http://chungyan5.no-ip.org/vc/?root=webserver_8bit webserver_8bit]
====add-on====
*The Web Server included in uIP 1.0 has been designed to load/reload the entire page (either html/shtml files) in response to a HTTP GET command, e.g.
GET /index.html HTTP/1.1
GET /abc.shtml HTTP/1.1
*As a result, if the webpage is required to refresh the dynamic data periodically, the surfing experience will be degraded by the large transfer of datastream.
*In consideration of the above issue, a solution is proposed here, so that the webserver can handle this kind of cgi HTTP-request
GET /abc.shtml?val=500.0&button=Set HTTP/1.1

===DNS Resolver===
*Use project [http://chungyan5.no-ip.org/vc/?root=dns_resolv_8bit dns_resolv_8bit]
*The uIP DNS resolver functions are used to lookup a hostname and map it to a numerical IP address. It maintains a list of resolved hostnames that can be queried with the resolv_lookup() function. New hostnames can be resolved using the resolv_query() function.
*When a hostname has been resolved (or found to be non-existant), the resolver code calls a callback function called resolv_found() that must be implemented by the module that uses the resolver.
*Router Setting
**Special attention should be paid to router setting, when the DNS Server address is acquired by DHCP.
**The DNS Resolver module assumes that the DNS server can support DNS TYPE of ANY, MX, CNAME and A. See http://www.networksorcery.com/enp/protocol/dns.htm for definitions of these options.
*In case the router itself does not support these options, the router should be set to deliver a DNS Server address which support these options.

===SMTP Mail Client===
*Use project [http://chungyan5.no-ip.org/vc/?root=smtpc_8bit smtpc_8bit]
*The SMTP client searches the ip address of the mail server by a DNS call. It then logins to the server with the email account name and address using AUTH LOGIN. If login is successful, the mail is sent to the list of recipients.

===SNMP Agent (Not implemented yet)===
*Simple Network Management Protocol (SNMP) is a standard protocol to access variables to remote device via the Internet. Reference in [http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol wikipedia.org]
*It belongs to the Application Layer, as in HTTP.
*If a device is SNMP compatible, any SNMP compatible host system can monitor and control that device.

====Components in a SNMP System====
*Network Management Station (NMS)
**This is a client, initiating SNMP communication.
**This can be a PC with an NMS software (e.g. [http://nino.sourceforge.net/nino/index.html NINO]), polling data from the SNMP agents periodically.
*SNMP Agents
**These are servers, responding to one or multiple NMS requests.
*Management Information Base (MIB)
**A special collection of variables managed by the SNMP agents.
**MIB has a tree-like structure.
**An Object Identifier (OID) is given for each node.
**Data are stored at the end-nodes.
**Private variables may be constructed under the "enterprise" sub-tree.
**The OID for "enterprise" can be obtained from [http://www.iana.org/cgi-bin/enterprise.pl Internet Assigned Number Authority (IANA)].

====Abstract Syntax Notation====
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

====To-Do List====
*Build MIB file.
**Build MIB file's written in [http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ANS.1 notation].
**Build MIB compiler tool to compile MIB file to binary file (store tree structure: oid, id, data type, value, position) and C header file (store id to determine a function service the oid).
**Build MIB converter tool to convert binary MIB file to C header file (embedded to code). Note: binary MIB file can store in MMC/SD card (don't need MIB converter tool).
*Build [http://www.rane.com/note161.html snmp's PDU use BER (Base encoding rules)] encoder and decoder library to process data that's transfer between NMS and agents.
*Build snmp API use [http://www.sics.se/~adam/uip/index.php/Main_Page uIP-stack] to communicate between NMS and Agents (open two ports: The manager speak to agents on one port, the agent responds manager on the other port).
*Build binary MIB file reader library.
*Build functions service oid tree.
*Merge MIB ANS.1 file to NMS.

==Reference==
===uIP===
*[http://www.sics.se/~adam/uip/index.php/Main_Page uIP Description]
*[http://www.sics.se/~adam/uip/index.php/Documentation uIP Documentation]
*[http://www.sics.se/~adam/uip/index.php/Download Download]
*[http://sourceforge.net/cvs/?group_id=186227 CVS Repository]
===lwIP===
*[http://savannah.nongnu.org/projects/lwip/ lwIP Description]
*[http://www.nongnu.org/lwip/ Documentation]
===HTML===
*[http://www.w3schools.com/default.asp W3 Schools]: Learning how to write HTML and JavaScript
===SNMP===
*[http://www.snmplink.org SNMP Link]: Information on SNMP Agents
*[http://pen.iana.org/pen/PenApplication.page IANA]: Applying a Private Enterprise Number
*[http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ASN.1]: Abstract Syntax Notation One (ASN.1):Specification of basic notation

UIP

2010-08-04T15:28:53Z

Thai: /* SNMP Agent (Not implemented yet) */

This wiki describes how to use uIP (a Light-weight TCP/IP stack) for developing ethernet applications for 8/16-bit embedded system (see [{{SERVER}}/Ethernet_Module Ethernet_Module]).

==Introduction==
*Developed by Adam Dunkels of the Networked Embedded Systems group at the Swedish Institute of Computer Science.
*[http://www.sics.se/~adam/uip/ uIP] is under the [http://www.sics.se/~adam/uip/index.php/License BSD-style license]

==Bug List==
*DHCP
**dhcp client fault from buffalo router
**occasionally cannot access webserver with dhcp
*DHCP
**dhcp client fault from main router
**occasionally cannot access webserver with dhcp
**possible cause: module tries to get IP configuration when switching on and off too frequently. This causes the router to enter into an unknown state. Even using the static mode with the same IP cannot get Internet access properly. When wait for some time and switch on the module again, the router may have been "reset", and the connection is ok again.
*SMTP
**some router cannot used SMTP module
**the router return its own IP as DNS resolver, and it does support only parsing direct IP function
**desktop applications (e.g. outlook, thunderbird, webmail) do not use DNS resolver (UDP application) to connect to the mail server, but use TCP/IP to do the job

==To-Do List==
*32kB constant limitations
**see if webserver can be stored in flash in file system
*[{{SERVER}}/Ethernet_Module#SNMP_Agent SNMP]
**porting snmp to uip
**reference to lwip
**a API(or any method) to let other system to talk to our device OR by scpi, modbus
*https by SSL
**on chip SSL(more faster) OR software SSL(need to upgrade CPU power to process the calculation)
**reference - http://www.networkworld.com/news/tech/2002/0729tech.html

==Porting==
===CVS Repository===
{|border="1" cellspacing="0" cellpadding="5"
! Attribute !! Value
|-valign="top"
| Host || uip-stack.cvs.sourceforge.net
|-
| Repository Path || /cvsroot/uip-stack
|-
| Connection Type || pserver
|-
| User || anonymous
|-
|}

===Patches===
*Changes made to CVS Repository for porting to [http://chungyan5.no-ip.org/vc/?root=freertos_posix freertos_posix]
*uip-patch-1.0-01.diff (minimal)
**'''uip.c'''
***Comment out all DEBUG_PRINTF(...) in lines 1, 323, 910, 1015, 1070, 1863, 1868, 1869
*uip-patch-1.0-02.diff (for pic30-elf-gcc compiler v3.01 or above)
**'''uip.h'''
***Change line 1070 to # define HTONS(n) (u16_t)(((((u16_t) (n)) << 8)&0xff00) | ((((u16_t) (n)) >> 8)&0x00ff))
**'''psock.c'''
***Change line 188 to s->sendptr = (u8_t*) buf;
***Change lines 276, 303 to buf_setup(&psock->buf, (u8_t*)(psock->bufptr), psock->bufsize);
***Change line 334 to buf_setup(&psock->buf, (u8_t*)buffer, buffersize);

===Implementation===
*Include the following files to use the uIP stack
**timer.c
**uip.c
**uip_arp.c
**psock.c
*The following files have been created to port uIP 1.0 to dsPic33F development board using FreeRTOS
*[http://chungyan5.no-ip.org/vc/trunk/demo_posix/dspic/drivers/?root=freertos_posix clock-arch.c]: return the os tick counts since the system is turned on.
*[http://chungyan5.no-ip.org/vc/trunk/demo_posix/dspic/drivers/include/?root=freertos_posix clock-arch.h]: a constant specifying the number of os ticks in one second.
*uip-config.h: configuration for your application.

==uIP Ethernet Application==
*The following applications are modified from the demo applications in uIP.

===DHCP Client===
*Use project [http://chungyan5.no-ip.org/vc/?root=dhcpc_8bit dhcpc_8bit]
*Enable UDP in "uip-config.h"
#define UIP_CONF_UDP 1
*Make sure your uip buffer size is large enough (DHCP messages from some servers can be more than 500 bytes). In my setting, I use 1536 in "uip-config.h"
#define UIP_CONF_BUFFER_SIZE 1536

===Web Server===
*Use project [http://chungyan5.no-ip.org/vc/?root=webserver_8bit webserver_8bit]
====add-on====
*The Web Server included in uIP 1.0 has been designed to load/reload the entire page (either html/shtml files) in response to a HTTP GET command, e.g.
GET /index.html HTTP/1.1
GET /abc.shtml HTTP/1.1
*As a result, if the webpage is required to refresh the dynamic data periodically, the surfing experience will be degraded by the large transfer of datastream.
*In consideration of the above issue, a solution is proposed here, so that the webserver can handle this kind of cgi HTTP-request
GET /abc.shtml?val=500.0&button=Set HTTP/1.1

===DNS Resolver===
*Use project [http://chungyan5.no-ip.org/vc/?root=dns_resolv_8bit dns_resolv_8bit]
*The uIP DNS resolver functions are used to lookup a hostname and map it to a numerical IP address. It maintains a list of resolved hostnames that can be queried with the resolv_lookup() function. New hostnames can be resolved using the resolv_query() function.
*When a hostname has been resolved (or found to be non-existant), the resolver code calls a callback function called resolv_found() that must be implemented by the module that uses the resolver.
*Router Setting
**Special attention should be paid to router setting, when the DNS Server address is acquired by DHCP.
**The DNS Resolver module assumes that the DNS server can support DNS TYPE of ANY, MX, CNAME and A. See http://www.networksorcery.com/enp/protocol/dns.htm for definitions of these options.
*In case the router itself does not support these options, the router should be set to deliver a DNS Server address which support these options.

===SMTP Mail Client===
*Use project [http://chungyan5.no-ip.org/vc/?root=smtpc_8bit smtpc_8bit]
*The SMTP client searches the ip address of the mail server by a DNS call. It then logins to the server with the email account name and address using AUTH LOGIN. If login is successful, the mail is sent to the list of recipients.

===SNMP Agent (Not implemented yet)===
*Simple Network Management Protocol (SNMP) is a standard protocol to access variables to remote device via the Internet. Reference in [http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol wikipedia.org]
*It belongs to the Application Layer, as in HTTP.
*If a device is SNMP compatible, any SNMP compatible host system can monitor and control that device.

====Components in a SNMP System====
*Network Management Station (NMS)
**This is a client, initiating SNMP communication.
**This can be a PC with an NMS software (e.g. [http://nino.sourceforge.net/nino/index.html NINO]), polling data from the SNMP agents periodically.
*SNMP Agents
**These are servers, responding to one or multiple NMS requests.
*Management Information Base (MIB)
**A special collection of variables managed by the SNMP agents.
**MIB has a tree-like structure.
**An Object Identifier (OID) is given for each node.
**Data are stored at the end-nodes.
**Private variables may be constructed under the "enterprise" sub-tree.
**The OID for "enterprise" can be obtained from [http://www.iana.org/cgi-bin/enterprise.pl Internet Assigned Number Authority (IANA)].

====Abstract Syntax Notation====
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

====To-Do List====
*Build MIB file.
**Build MIB file's written in [http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ANS.1 notation].
**Build MIB compiler tool to compile MIB file to binary file (store tree structure: oid, id, data type, value, position) and C header file (store id to determine a function service the oid).
**Build MIB converter tool to convert binary MIB file to C header file (embedded to code). Note: binary MIB file can store in MMC/SD card (don't need MIB converter tool).
*Build [http://www.vijaymukhi.com/vmis/ber.htm BER] (Base encoding rules) encoder and decoder library to process data that's transfer between NMS and agents.
*Build snmp API use BER format on [http://www.sics.se/~adam/uip/index.php/Main_Page uIP-stack] to communicate between NMS and Agents (open two ports: The manager speak to agents on one port, the agent responds manager on the other port).
*Build binary MIB file reader library.
*Build functions service oid tree.
*Merge MIB ANS.1 file to NMS.

==Reference==
===uIP===
*[http://www.sics.se/~adam/uip/index.php/Main_Page uIP Description]
*[http://www.sics.se/~adam/uip/index.php/Documentation uIP Documentation]
*[http://www.sics.se/~adam/uip/index.php/Download Download]
*[http://sourceforge.net/cvs/?group_id=186227 CVS Repository]
===lwIP===
*[http://savannah.nongnu.org/projects/lwip/ lwIP Description]
*[http://www.nongnu.org/lwip/ Documentation]
===HTML===
*[http://www.w3schools.com/default.asp W3 Schools]: Learning how to write HTML and JavaScript
===SNMP===
*[http://www.snmplink.org SNMP Link]: Information on SNMP Agents
*[http://pen.iana.org/pen/PenApplication.page IANA]: Applying a Private Enterprise Number
*[http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ASN.1]: Abstract Syntax Notation One (ASN.1):Specification of basic notation

UIP

2010-08-04T13:05:06Z

Thai: /* SNMP */

This wiki describes how to use uIP (a Light-weight TCP/IP stack) for developing ethernet applications for 8/16-bit embedded system (see [{{SERVER}}/Ethernet_Module Ethernet_Module]).

==Introduction==
*Developed by Adam Dunkels of the Networked Embedded Systems group at the Swedish Institute of Computer Science.
*[http://www.sics.se/~adam/uip/ uIP] is under the [http://www.sics.se/~adam/uip/index.php/License BSD-style license]

==Bug List==
*DHCP
**dhcp client fault from buffalo router
**occasionally cannot access webserver with dhcp
*DHCP
**dhcp client fault from main router
**occasionally cannot access webserver with dhcp
**possible cause: module tries to get IP configuration when switching on and off too frequently. This causes the router to enter into an unknown state. Even using the static mode with the same IP cannot get Internet access properly. When wait for some time and switch on the module again, the router may have been "reset", and the connection is ok again.
*SMTP
**some router cannot used SMTP module
**the router return its own IP as DNS resolver, and it does support only parsing direct IP function
**desktop applications (e.g. outlook, thunderbird, webmail) do not use DNS resolver (UDP application) to connect to the mail server, but use TCP/IP to do the job

==To-Do List==
*32kB constant limitations
**see if webserver can be stored in flash in file system
*[{{SERVER}}/Ethernet_Module#SNMP_Agent SNMP]
**porting snmp to uip
**reference to lwip
**a API(or any method) to let other system to talk to our device OR by scpi, modbus
*https by SSL
**on chip SSL(more faster) OR software SSL(need to upgrade CPU power to process the calculation)
**reference - http://www.networkworld.com/news/tech/2002/0729tech.html

==Porting==
===CVS Repository===
{|border="1" cellspacing="0" cellpadding="5"
! Attribute !! Value
|-valign="top"
| Host || uip-stack.cvs.sourceforge.net
|-
| Repository Path || /cvsroot/uip-stack
|-
| Connection Type || pserver
|-
| User || anonymous
|-
|}

===Patches===
*Changes made to CVS Repository for porting to [http://chungyan5.no-ip.org/vc/?root=freertos_posix freertos_posix]
*uip-patch-1.0-01.diff (minimal)
**'''uip.c'''
***Comment out all DEBUG_PRINTF(...) in lines 1, 323, 910, 1015, 1070, 1863, 1868, 1869
*uip-patch-1.0-02.diff (for pic30-elf-gcc compiler v3.01 or above)
**'''uip.h'''
***Change line 1070 to # define HTONS(n) (u16_t)(((((u16_t) (n)) << 8)&0xff00) | ((((u16_t) (n)) >> 8)&0x00ff))
**'''psock.c'''
***Change line 188 to s->sendptr = (u8_t*) buf;
***Change lines 276, 303 to buf_setup(&psock->buf, (u8_t*)(psock->bufptr), psock->bufsize);
***Change line 334 to buf_setup(&psock->buf, (u8_t*)buffer, buffersize);

===Implementation===
*Include the following files to use the uIP stack
**timer.c
**uip.c
**uip_arp.c
**psock.c
*The following files have been created to port uIP 1.0 to dsPic33F development board using FreeRTOS
*[http://chungyan5.no-ip.org/vc/trunk/demo_posix/dspic/drivers/?root=freertos_posix clock-arch.c]: return the os tick counts since the system is turned on.
*[http://chungyan5.no-ip.org/vc/trunk/demo_posix/dspic/drivers/include/?root=freertos_posix clock-arch.h]: a constant specifying the number of os ticks in one second.
*uip-config.h: configuration for your application.

==uIP Ethernet Application==
*The following applications are modified from the demo applications in uIP.

===DHCP Client===
*Use project [http://chungyan5.no-ip.org/vc/?root=dhcpc_8bit dhcpc_8bit]
*Enable UDP in "uip-config.h"
#define UIP_CONF_UDP 1
*Make sure your uip buffer size is large enough (DHCP messages from some servers can be more than 500 bytes). In my setting, I use 1536 in "uip-config.h"
#define UIP_CONF_BUFFER_SIZE 1536

===Web Server===
*Use project [http://chungyan5.no-ip.org/vc/?root=webserver_8bit webserver_8bit]
====add-on====
*The Web Server included in uIP 1.0 has been designed to load/reload the entire page (either html/shtml files) in response to a HTTP GET command, e.g.
GET /index.html HTTP/1.1
GET /abc.shtml HTTP/1.1
*As a result, if the webpage is required to refresh the dynamic data periodically, the surfing experience will be degraded by the large transfer of datastream.
*In consideration of the above issue, a solution is proposed here, so that the webserver can handle this kind of cgi HTTP-request
GET /abc.shtml?val=500.0&button=Set HTTP/1.1

===DNS Resolver===
*Use project [http://chungyan5.no-ip.org/vc/?root=dns_resolv_8bit dns_resolv_8bit]
*The uIP DNS resolver functions are used to lookup a hostname and map it to a numerical IP address. It maintains a list of resolved hostnames that can be queried with the resolv_lookup() function. New hostnames can be resolved using the resolv_query() function.
*When a hostname has been resolved (or found to be non-existant), the resolver code calls a callback function called resolv_found() that must be implemented by the module that uses the resolver.
*Router Setting
**Special attention should be paid to router setting, when the DNS Server address is acquired by DHCP.
**The DNS Resolver module assumes that the DNS server can support DNS TYPE of ANY, MX, CNAME and A. See http://www.networksorcery.com/enp/protocol/dns.htm for definitions of these options.
*In case the router itself does not support these options, the router should be set to deliver a DNS Server address which support these options.

===SMTP Mail Client===
*Use project [http://chungyan5.no-ip.org/vc/?root=smtpc_8bit smtpc_8bit]
*The SMTP client searches the ip address of the mail server by a DNS call. It then logins to the server with the email account name and address using AUTH LOGIN. If login is successful, the mail is sent to the list of recipients.

===SNMP Agent (Not implemented yet)===
*Simple Network Management Protocol (SNMP) is a standard protocol to access variables to remote device via the Internet. Reference in [http://en.wikipedia.org/wiki/Simple_Network_Management_Protocol wikipedia.org]
*It belongs to the Application Layer, as in HTTP.
*If a device is SNMP compatible, any SNMP compatible host system can monitor and control that device.

====Components in a SNMP System====
*Network Management Station (NMS)
**This is a client, initiating SNMP communication.
**This can be a PC with an NMS software (e.g. [http://nino.sourceforge.net/nino/index.html NINO]), polling data from the SNMP agents periodically.
*SNMP Agents
**These are servers, responding to one or multiple NMS requests.
*Management Information Base (MIB)
**A special collection of variables managed by the SNMP agents.
**MIB has a tree-like structure.
**An Object Identifier (OID) is given for each node.
**Data are stored at the end-nodes.
**Private variables may be constructed under the "enterprise" sub-tree.
**The OID for "enterprise" can be obtained from [http://www.iana.org/cgi-bin/enterprise.pl Internet Assigned Number Authority (IANA)].

====Abstract Syntax Notation====
*Each MIB variable contains several attributes, such as data type, access type and object identifier.
*Abstract Syntax Notation version 1 (ASN.1) is a language to define these attributes in SNMP.

==Reference==
===uIP===
*[http://www.sics.se/~adam/uip/index.php/Main_Page uIP Description]
*[http://www.sics.se/~adam/uip/index.php/Documentation uIP Documentation]
*[http://www.sics.se/~adam/uip/index.php/Download Download]
*[http://sourceforge.net/cvs/?group_id=186227 CVS Repository]
===lwIP===
*[http://savannah.nongnu.org/projects/lwip/ lwIP Description]
*[http://www.nongnu.org/lwip/ Documentation]
===HTML===
*[http://www.w3schools.com/default.asp W3 Schools]: Learning how to write HTML and JavaScript
===SNMP===
*[http://www.snmplink.org SNMP Link]: Information on SNMP Agents
*[http://pen.iana.org/pen/PenApplication.page IANA]: Applying a Private Enterprise Number
*[http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf ASN.1]: Abstract Syntax Notation One (ASN.1):Specification of basic notation