linuxcnc-hal-sys 0.1.5

Generated, unsafe Rust bindings to the LinuxCNC HAL submodule
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

/* 		hy_comm.h

   By S.Alford
 
   These library of functions are designed to enable a program send and
   receive data from a Huanyang VFD. This device does not use a standard
   Modbus function code or data structure.
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                    
 
   This code has its origins with libmodbus
   
 */


#ifndef HY_COMM_H
#define HY_COMM_H

#include <stdint.h>
#include <termios.h>
#include <limits.h>

#define MAX_DATA_LENGTH 		246
#define MAX_QUERY_LENGTH 		55
#define MAX_RESPONSE_LENGTH 	1024
#define MIN_QUERY_SIZE        	8
#define MAX_PACKET_SIZE      	8

/* Time out between frames in microsecond */
#define TIME_OUT_BEGIN_OF_FRAME 500000
#define TIME_OUT_END_OF_FRAME   500000

#ifndef FALSE
#define FALSE 					0
#endif

#ifndef TRUE
#define TRUE 					1
#endif

/* Local */
#define COMM_TIME_OUT           -0x0C
#define PORT_SOCKET_FAILURE     -0x0D
#define SELECT_FAILURE          -0x0E
#define TOO_MANY_DATAS          -0x0F
#define INVALID_CRC             -0x10
#define INVALID_EXCEPTION_CODE  -0x11


// Huanyang Function Codes
#define	FUNCTION_READ			0x01
#define	FUNCTION_WRITE			0x02
#define	WRITE_CONTROL_DATA		0x03
#define	READ_CONTROL_STATUS		0x04
#define	WRITE_FREQ_DATA			0x05
#define	LOOP_TEST				0x08

/***********************************************************************

	 Note: All functions used for sending or receiving data via
	       hycomm return these return values.


	Returns:	string_length if OK
			0 if failed
			Less than 0 for exception errors

***********************************************************************/

#define COMMS_FAILURE 			0
#define ILLEGAL_FUNCTION 		-1
#define ILLEGAL_PARAMETER	 	-2
#define ILLEGAL_DATA_VALUE 		-3
#define SLAVE_DEVICE_FAILURE 	-4
#define ACKNOWLEDGE 			-5
#define SLAVE_DEVICE_BUSY 		-6
#define NEGATIVE_ACKNOWLEDGE 	-7
#define MEMORY_PARITY_ERROR 	-8

#define PORT_FAILURE 			-11

typedef struct _hycomm_param_t {
	char device[PATH_MAX];		/* Device: "/dev/ttyS0" */
	int print_errors;			/* whether or not to print errors.  0=no print, 1=print */
	int baud;					/* Bauds: 19200 */
	char parity[5];				/* Parity: "even", "odd", "none" */
	int data_bit;				/* Data bit */
	int stop_bit;				/* Stop bit */
	struct termios old_tios;	/* Save old termios settings */
	int fd;						/* Descriptor (tty or socket) */
	int debug;					/* Flag debug */
} hycomm_param_t;


/* Initializes the hycomm_param_t structure for RTU.
   - device: "/dev/ttyS0"
   - baud:   9600, 19200, 57600, 115200, etc
   - parity: "even", "odd" or "none" 
   - data_bits: 5, 6, 7, 8 
   - stop_bits: 1, 2
*/

typedef struct _hycomm_data_t {
	unsigned char slave;			/* slave address */
	unsigned char function;			/* function code */
	unsigned char parameter;		/* PDxxx parameter */
	int data;						/* Data to send */
	unsigned char ret_length;		/* length of data returned from slave */
	unsigned char ret_parameter;	/* parameter returned from slave */
	int ret_data;					/* Data returned from slave */
} hycomm_data_t;


void hycomm_init(hycomm_param_t *hc_param, const char *device,
                     int baud, const char *parity, int data_bit,
                     int stop_bit);

void hycomm_close(hycomm_param_t *hc_param);

void hycomm_init_rtu(hycomm_param_t *hc_param, const char *device,
                     int baud, const char *parity, int data_bit,
                     int stop_bit);

int hycomm_connect(hycomm_param_t *hc_param);

int hy_comm(hycomm_param_t *hc_param, hycomm_data_t *hc_data);


#endif  /* HY_COMM_H */