Skip to content

Commit

Permalink
reworked documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Alois Zoitl committed Nov 3, 2009
1 parent 69a8168 commit 2976a6b
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 5 deletions.
10 changes: 10 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ Compile for PCs:
2.4 The resulting executable will be in the directory
./bin/pc

Directory structure:
====================
- bin ... The resulting binaries and make files for different ports (currently only pc)
- doc ... Doxygen generated documentation (has to be generated for the SVN version) and Coding rules
- data ... EDS file for the default application
- src
- cip ... the CIP layer of the stack
- enet_encap ... the Ethernet encapsulation layer
- ports ... the platform specific code

Documentation:
==============
The documentation of the functions of OpENer is part of the source code. You
Expand Down
2 changes: 2 additions & 0 deletions bin/pc/Makefile.release
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ SOURCES= \
../../src/cip/ciptcpipinterface.c \
../../src/cip/cipidentity.c \
../../src/cip/cipethernetlink.c \
../../src/cip/appcontype.c \
../../src/enet_encap/cpf.c \
../../src/enet_encap/endianconv.c \
../../src/enet_encap/encap.c \
Expand All @@ -42,6 +43,7 @@ OBJECTS= \
../../src/cip/ciptcpipinterface.o \
../../src/cip/cipidentity.o \
../../src/cip/cipethernetlink.o \
../../src/cip/appcontype.o \
../../src/enet_encap/cpf.o \
../../src/enet_encap/endianconv.o \
../../src/enet_encap/encap.o
Expand Down
14 changes: 10 additions & 4 deletions src/opener_api.h
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,6 @@ IApp_CloseSocket(int pa_nSockFd);
*
* \section further_reading_sec Further Topics
* - \ref porting
* - \ref building_products
* - \ref extending
* - \ref license
*
Expand Down Expand Up @@ -564,15 +563,22 @@ IApp_CloseSocket(int pa_nSockFd);
* code. An overview and explanation of OpENer's call-back API may be found in
* the module \ref CIP_CALLBACK_API.
*
* \page building_products Using OpENer in Products
*
* \page extending Extending OpENer
* OpENer provides an API for adding own CIP objects and instances with
* specific services and attributes. Therefore OpENer can be easily adapted to
* support different device profiles and specific CIP objects needed for your
* device. The functions to be used are:
* - S_CIP_Class * createCIPClass(EIP_UINT32 pa_nClassID, int pa_nNr_of_ClassAttributes, EIP_UINT32 pa_nClassGetAttrAllMask, int pa_nNr_of_ClassServices, int pa_nNr_of_InstanceAttributes, EIP_UINT32 pa_nInstGetAttrAllMask, int pa_nNr_of_InstanceServices, int pa_nNr_of_Instances, char *pa_acName, EIP_UINT16 pa_nRevision);
* - S_CIP_Instance * addCIPInstances(S_CIP_Class *pa_pstCIPObject, int pa_nNr_of_Instances);
* - S_CIP_Instance * addCIPInstance(S_CIP_Class * pa_pstCIPClass, EIP_UINT32 pa_nInstanceId);
* - void insertAttribute(S_CIP_Instance *pa_pInstance, EIP_UINT8 pa_nAttributeNr, EIP_UINT8 pa_nCIP_Type, void* pa_pt2data);
* - void insertService(S_CIP_Class *pa_pClass, EIP_UINT8 pa_nServiceNr, TCIPServiceFunc pa_ptfuncService, char *name);
*
* \page license OpENer Open Source License
* The OpENer Open Source License is an adapted BSD style license. The
* adaptations include the use of the term EtherNet/IP(TM) and the necessary
* guarding conditions for using OpENer in own products. For this please look
* in \ref building_products and the license text as shown below:
* in license text as shown below:
*
* \include "license.txt"
*
Expand Down
2 changes: 1 addition & 1 deletion src/ports/platform-pc/opener_user_conf.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
#define OPENER_DEVICE_PRODUCT_CODE 200
#define OPENER_DEVICE_MAJOR_REVISION 1
#define OPENER_DEVICE_MINOR_REVISION 2
#define OPENER_DEVICE_NAME "ENetIP EC"
#define OPENER_DEVICE_NAME "OpENer PC"

/*! Define the number of supported explicit connections.
* According to ODVA's PUB 70 this number should be greater than 6.
Expand Down

0 comments on commit 2976a6b

Please sign in to comment.